Database Role
List database roles¶
GET/api/v2/databases/{database}/database-roles
List database roles
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
Query Parameters¶
Parameter | Description |
---|---|
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¶
Code | Description |
---|---|
200 | successful |
202 | Successfully accepted the request, but it is not completed yet. |
Create a database role¶
POST/api/v2/databases/{database}/database-roles
Create a database role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
Query Parameters¶
Parameter | Description |
---|---|
createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
Delete a database role¶
DELETE/api/v2/databases/{database}/database-roles/{name}
Delete a database role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
Create a new database role by cloning from the specified resource¶
POST/api/v2/databases/{database}/database-roles/{name}:clone
Create a new database role by cloning from the specified resource
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
targetDatabase string | Database of the target resource. Defaults to the source's database |
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
List all grants to the role¶
GET/api/v2/databases/{database}/database-roles/{name}/grants
List all grants to the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
showLimit integer | Query parameter to limit the maximum number of rows returned by a command. |
Response¶
Code | Description |
---|---|
200 | successful |
202 | Successfully accepted the request, but it is not completed yet. |
Grant privileges to the role¶
POST/api/v2/databases/{database}/database-roles/{name}/grants
Grant privileges to the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
Revoke grants from the role¶
POST/api/v2/databases/{database}/database-roles/{name}/grants:revoke
Revoke grants from the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
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.
|
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
List all future grants to the role¶
GET/api/v2/databases/{database}/database-roles/{name}/future-grants
List all future grants to the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
showLimit integer | Query parameter to limit the maximum number of rows returned by a command. |
Response¶
Code | Description |
---|---|
200 | successful |
202 | Successfully accepted the request, but it is not completed yet. |
Grant future privileges to the role¶
POST/api/v2/databases/{database}/database-roles/{name}/future-grants
Grant future privileges to the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |
Revoke future grants from the role¶
POST/api/v2/databases/{database}/database-roles/{name}/future-grants:revoke
Revoke future grants from the role
Path Parameters¶
Parameter | Description |
---|---|
database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
name string | Identifier (i.e. name) for the resource. |
Query Parameters¶
Parameter | Description |
---|---|
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.
|
Response¶
Code | Description |
---|---|
200 | Successful request. |
202 | Successfully accepted the request, but it is not completed yet. |