URL: http://<db.host>:<db.port>/delete/user
Deletes an existing user.
NOTE: This endpoint should be used for on-premise deployments only.
Input Parameter Description
| Name | Type | Description |
|---|---|---|
| name | string | Name of the user to be deleted. Must be an existing user. |
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ). |
Output Parameter Description
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 | 'delete_user_response' or 'none' in case of an error | |||||||||
| data | String | Empty string | |||||||||
| data_str | JSON or String | This embedded JSON represents the result of the /delete/user endpoint:
Empty string in case of an error. |
