List Users
Operation ID: listUsers
List users of the platform tenant
Request
URI
GET
https://{api_host}/api/v1/tenants/{tenantId}/users
COPY
Path Parameters
string
tenantId
Required
The ID of the tenant which the listed users belongs to
Query Parameters
integer
offset
Optional
The start index of users to return
integer
limit
Optional
Maximum number of users to return
Responses
200
Users of the platform tenant are returned
Returns PageOfUsers of type(s) application/json
{
"page_info": {
"total": 1,
"offset": 6,
"limit": 0
},
"items": [
{
"tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
"role": "PROVIDER_ADMIN",
"canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
"user_id": "rachelw",
"cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f",
"active": true,
"user_arn": "arn:aws:iam::account:user/user-name-with-path",
"cd_user_id": "rachelw",
"email": "[email protected]",
"username": "username"
},
{
"tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
"role": "PROVIDER_ADMIN",
"canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
"user_id": "rachelw",
"cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f",
"active": true,
"user_arn": "arn:aws:iam::account:user/user-name-with-path",
"cd_user_id": "rachelw",
"email": "[email protected]",
"username": "username"
}
]
}