Get role list
Gets the list of all roles in a CelerData Cloud BYOC account.
Request
Basic information | |
---|---|
HTTP URL | https://cloud-api.celerdata.com/api/1.0/role-list |
HTTP method | GET |
Frequency | 600/minute |
Header parameters
Parameter | Example value | Required | Type | Description |
---|---|---|---|---|
Authorization | Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY | Yes | String | The access token used to access the CelerData Cloud BYOC API. Format: Bearer <access_token> . |
See Obtain access token.
Response
Sample response
{
"code": 20000,
"data": {
"roles": [
{
"id": "12345678-1234-1234-1234-123456789012",
"name": "Account_Admin",
"createAt": 1701661969037,
"desc": "SYSTEM_CREATED"
}
]
}
}
Response elements
Parameter | Example value | Type | Description |
---|---|---|---|
code | 20000 | Integer | The error code. If the error code returned is 20000 , the request succeeded. If any other error code is returned, the request failed. |
data | - | Object | The result of the API call. The data object may not be returned for some API actions. It consists of the element roles . |
data.roles | - | Array | An array of one or more objects, each of which consists of the role details. |
data.roles[0] | - | Object | The details of a role presented as an object. Each object consists of the following elements: id , name , createAt , and desc . |
data.roles[0].id | - | String | The ID of the role. You need this attribute when you invite new members and assign roles to them using the API invite-member . |
data.roles[0].name | - | String | The name of the role. |
data.roles[0].createAt | - | Timestamp | The timestamp when the role was created. |
data.roles[0].desc | - | String | The description of the role. |
message | - | String | The error message. This element is returned only when the code returned is not 20000 .NOTICE Do not conclude whether a request succeeded or failed based on the return value of message . |