Listing the users of a tenant¶
Note
The Admin API requires no token. The Admin API is typically protected at the network level.
Send the request as GET to the path /admin/v1/tenants/{tenant_id}/users.
Request¶
The following parameters are available:
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id |
path | string |
yes | ID of the tenant. |
Example¶
Example of the response body:
{
"users": [
{
"id": "usr_abc123",
"tenant_id": "ten_xyz",
"email": "alice@example.com",
"name": "Alice"
}
]
}
Responses¶
The endpoint answers the request with the following status codes:
| Status code | Description |
|---|---|
200 |
List of users. |