Role

List roles¶

GET/api/v2/roles
List roles

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.

Create a role¶

POST/api/v2/roles
Create a role

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

Delete a role¶

DELETE/api/v2/roles/{name}
Delete a role

Path Parameters¶

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

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

List all grants to the role¶

GET/api/v2/roles/{name}/grants
List all grants to the role

Response¶

CodeDescription
200
successful
202

Grant privileges to the role¶

POST/api/v2/roles/{name}/grants
Grant privileges to the role

Response¶

CodeDescription
200
202

Revoke grants from the role¶

POST/api/v2/roles/{name}/grants:revoke
Revoke grants from the role

Query Parameters¶

ParameterDescription
mode string
Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.
  • restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.
  • cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege.

Response¶

CodeDescription
200
202

List all grants of the role¶

GET/api/v2/roles/{name}/grants-of
List all grants of the role

Response¶

CodeDescription
200
successful
202

List all grants on the role¶

GET/api/v2/roles/{name}/grants-on
List all grants on the role

Response¶

CodeDescription
200
successful
202

List all future grants to the role¶

GET/api/v2/roles/{name}/future-grants
List all future grants to the role

Response¶

CodeDescription
200
successful
202

Grant future privileges to the role¶

POST/api/v2/roles/{name}/future-grants
Grant future privileges to the role

Response¶

CodeDescription
200
202

Revoke future grants from the role¶

POST/api/v2/roles/{name}/future-grants:revoke
Revoke future grants from the role

Response¶

CodeDescription
200
202
Language: English