User

Create a user¶

POST/api/v2/users
Create a user according to the parameters given

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

List users in the system¶

GET/api/v2/users
Lists the users in the system.

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.
fromName string
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Fetch information about a user¶

GET/api/v2/users/{name}
Fetch user information using the result of the DESCRIBE command

Path Parameters¶

ParameterDescription
name string
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Delete a user¶

DELETE/api/v2/users/{name}
Delete a user with the given name.

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Create a (or alter an existing) user¶

PUT/api/v2/users/{name}
Create a (or alter an existing) user. Even if the operation is just an alter, the full property set must be provided. Note that password is not currently altered by this operation but is supported for a newly-created object.

Response¶

CodeDescription
200
202

List all grants to the user¶

GET/api/v2/users/{name}/grants
List all grants to the user

Response¶

CodeDescription
200
successful
202

Grant a role to the user¶

POST/api/v2/users/{name}/grants
Grant a role to the user

Response¶

CodeDescription
200
202

Revoke grants from the user¶

POST/api/v2/users/{name}/grants:revoke
Revoke grants from the user

Response¶

CodeDescription
200
202
Language: English