Query Users
Operation ID: queryUsers
Query storage users in the storage tenant
Request
URI
GET
https://{api_host}/api/v1/users/query
COPY
Query Parameters
integer
offset
Optional
The start index of users to return
integer
limit
Optional
Maximum number of users to return
string
filter
Optional
The conditions to query storage users
Responses
200
Storage users in the storage tenant are returned
Returns
PageOfUsers
of type(s)
application/json
{
"items": [
{
"user_id": "rachelw",
"canonical_user_id": "68fb0f20-4a0c-4036-a584-cc3ee421093f",
"tenant_id": "bb8287a9-874e-46d2-abbd-58278e1ac046",
"active": false,
"username": "string",
"email": "[email protected]",
"role": "string",
"cd_user_id": "rachelw",
"cd_tenant_id": "40b97e3c-c3b1-4251-b7de-e9637324683f"
}
],
"page_info": {
"limit": 0,
"offset": 0,
"total": 0
}
}
array of
object
items
Optional
items
object
page_info
Optional
page_info
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v1/users/query