Get member list
Gets the list of all members in a CelerData Cloud BYOC account.
NOTE
This operation requires the Member Management privilege.
Request
Basic information | |
---|---|
HTTP URL | https://cloud-api.celerdata.com/api/1.0/users |
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": [
{
"account_id":"61eaba26",
"user_id": "61eaba26-82ee-4c7a-96aa-6805118de3cd",
"first_name": "anne",
"last_name": "young",
"email": "anne.young@a.com",
"state": "IN_USE",
"is_account_creator":false,
"create_at": 1710916833937
}
]
}
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 returns the list of member information. |
data.account_id | lbyx0bt7a | String | The ID of the account to which the member belongs. |
data.user_id | - | String | The ID of the member. |
data.first_name | - | String | The first name of the member. |
data.last_name | - | String | The last name of the member. |
data.email | - | String | The email address of the member. |
data.state | IN_USE | String | The state of the member. Valid values:
|
data.is_account_creator | true | Boolean | Whether the member is the creator of the account. |
data.create_at | - | Timestamp | The timestamp when the member was created. |
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 . |