Role
Create a role¶
POST/api/v2/roles
Create a role according to the parameters given
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| createMode | string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
| Parameter | Type | Description |
|---|
{
"name": "accountadmin",
"comment": "Account administrator can manage all aspects of the account.",
"created_on": "2019-08-24T14:15:22Z",
"is_default": true,
"is_current": true,
"is_inherited": true,
"assigned_to_users": 0,
"granted_to_roles": 0,
"granted_roles": 0,
"owner": "string"
}Response
| Code | Description | ||||
|---|---|---|---|---|---|
| 200 | Successful request. {
"status": "Request successfully completed"
}
| ||||
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 408 | |
| 409 | |
| 410 | |
| 429 | |
| 500 | |
| 503 | |
| 504 |
| Parameter | Type | Description |
|---|---|---|
| status | string | Message returned by the server. |
List roles available to account¶
GET/api/v2/roles
Lists the roles available to the user's account
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| 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
| Code | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 200 | successful [
{
"name": "accountadmin",
"comment": "Account administrator can manage all aspects of the account.",
"created_on": "2019-08-24T14:15:22Z",
"is_default": true,
"is_current": true,
"is_inherited": true,
"assigned_to_users": 0,
"granted_to_roles": 0,
"granted_roles": 0,
"owner": "string"
}
]
| |||||||||
| 202 | Successfully accepted the request, but it is not completed yet. {
"code": "392604",
"message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}
|
| 400 | Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry. |
| 401 | Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry. |
| 403 | Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled. |
| 404 | Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled. |
| 405 | Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST. |
| 408 | Request Timeout. This indicates that the request from the client timed out and was not completed by the server. |
| 409 | Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists. |
| 410 | Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable. |
| 429 | Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints. |
| 500 | Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support. |
| 503 | Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
| 504 | Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended. |
| Parameter | Type | Description |
|---|
Delete a role¶
DELETE/api/v2/roles/{name}
Delete a role with the given name.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Identifier (i.e. name) for the resource. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| ifExists | boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response
| Code | Description |
|---|---|
| 200 | |
| 202 |
| 400 | |
| 401 | |
| 403 | |
| 404 | |
| 405 | |
| 408 | |
| 409 | |
| 410 | |
| 429 | |
| 500 | |
| 503 | |
| 504 |