URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/alter/user
Alters a user.
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
name | string | Name of the user to be altered. Must be an existing user. | ||||||
action | string | Modification operation to be applied to the user.
|
||||||
value | string | The value of the modification, depending on input parameter action. | ||||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ). |
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
status | String | 'OK' or 'ERROR' | |||||||||
message | String | Empty if success or an error message | |||||||||
data_type | String | 'alter_user_request' or 'none' in case of an error | |||||||||
data | String | Empty string | |||||||||
data_str | JSON or String | This embedded JSON represents the result of the /alter/user endpoint:
Empty string in case of an error. |