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 URLhttps://cloud-api.celerdata.com/api/1.0/users
HTTP methodGET
Frequency600/minute

Header parameters

ParameterExample valueRequiredTypeDescription
AuthorizationBearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUYYesStringThe 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

ParameterExample valueTypeDescription
code20000IntegerThe error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data-ObjectThe 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_idlbyx0bt7aStringThe ID of the account to which the member belongs.
data.user_id-StringThe ID of the member.
data.first_name-StringThe first name of the member.
data.last_name-StringThe last name of the member.
data.email-StringThe email address of the member.
data.stateIN_USEStringThe state of the member. Valid values:
  • IN_USE: The member is in use.
  • NO_ACCOUNT_NAME: The member is not activated via the confirmation email.
data.is_account_creatortrueBooleanWhether the member is the creator of the account.
data.create_at-TimestampThe timestamp when the member was created.
message-StringThe 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.
In this article
Copyright © 2024 CelerData