List cloud accounts

GET 
/account

Lists the main account and the subaccounts associated with the main account.

Request

Query Parameters

pageSize string

Possible values: >= 1

Default value: 10

The number of items displayed per page.

pageNumber string

Possible values: >= 1

Default value: 1

The sequence number of the current page.

email string
The email address used by the cloud account.
Example: [email protected]
roleIdList string
The list of the role IDs.
Example: role-100001,role-100002
statusList string
The list of statuses. Supported cloud account statuses include INACTIVE, ACTIVATED, and DISABLED. If specified, only the cloud accounts in any specified statuses will be returned. If not specified, all cloud accounts will be returned.
Example: ACTIVATED,DISABLED

Header Parameters

x-maxone-role-id string

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The paginated list of accounts.

pageNumber int64

The sequence number of current page.

pageSize int64

The number of items returned per page.

records

object[]

The records in the current page.

Array [

createTimestamp int64

The creation timestamp of the account.

domain string

The domain name assigned to the main account.

email string

The email used by the cloud account.

id string

The ID of the cloud account.

isRoot boolean

Whether the cloud account is a main account.

roleId string

The ID of the role to which the cloud account is assigned.

rootAccountId string

The ID of the main account.

status string

Possible values: [INACTIVE, ACTIVATED, DISABLED]

The cloud account status.

]

total int64

The number of pages in total.

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "pageNumber": 0,
    "pageSize": 0,
    "records": [
      {
        "createTimestamp": 1685510869834,
        "domain": "string",
        "email": "[email protected]",
        "id": "account-100001",
        "isRoot": true,
        "roleId": "role-100001",
        "rootAccountId": "rootAccount-100002",
        "status": "INACTIVE"
      }
    ],
    "total": 0
  },
  "msg": "string"
}

Loading...