GET Users
Gets a list of users.
Request
URI
GET
https://{api_host}/api/v1/users
COPY
Query Parameters
string
type
Optional
Type of users for filtering. Use "content_creator" parameter to filter users that can create content.
boolean
showDetails
Optional
Constraints:
default: false
Indicates whether to include extended information in the results, such as the capabilities of the user and the groups they are a member of.
Responses
200
Successfully retrieved the list of users.
Returns
Array of
users.get.response
of type(s)
application/json
[
{
"id": "fe170f99-d5e5-44ef-80e7-0d0d35a8b2ec",
"username": "johndoe",
"roleIds": [
"00000000-0000-0000-0000-000000000002"
],
"capabilities": [
{
"id": "VIEW_SHARED_DASHBOARDS"
},
{
"id": "VIEW_INTERACTIVE_ANALYTICS"
},
{
"id": "VIEW_CONTENT_PACKS"
},
{
"id": "VIEW_SHARED_DASHBOARD_URLS"
},
{
"id": "VIEW_CONTENT_PACK_DASHBOARDS"
},
{
"id": "EDIT_USER_DASHBOARDS"
},
{
"id": "EDIT_EXPORT"
},
{
"id": "VIEW_SCHEDULED_REPORTS"
},
{
"id": "VIEW_ALERTS"
},
{
"id": "VIEW_USER_DASHBOARDS"
},
{
"id": "EDIT_INTERACTIVE_ANALYTICS"
},
{
"id": "EDIT_SHARED_DASHBOARD_URLS"
},
{
"id": "EDIT_CONTENT_PACKS"
},
{
"id": "EDIT_SCHEDULED_REPORTS"
},
{
"id": "VIEW_EXTRACTED_FIELDS"
},
{
"id": "VIEW_EXPORT"
},
{
"id": "EDIT_SHARED_DASHBOARDS"
},
{
"id": "EDIT_EXTRACTED_FIELDS"
}
],
"email": "[email protected]",
"type": "DEFAULT",
"authStatus": "ACTIVE",
"domain": "",
"upn": ""
},
{
"id": "377fda5b-37b5-4819-b528-796f2a6d9e0b",
"username": "admin",
"roleIds": [
"00000000-0000-0000-0000-000000000001"
],
"capabilities": [
{
"id": "VIEW_SHARED_DASHBOARDS"
},
{
"id": "ANALYTICS"
},
{
"id": "VIEW_FORWARDING"
},
{
"id": "EDIT_ALERTS"
},
{
"id": "EDIT_PARTITIONS"
},
{
"id": "VIEW_GENERAL_CONFIG"
},
{
"id": "VIEW_SSL_CONFIG"
},
{
"id": "EDIT_ADMIN"
},
{
"id": "EDIT_USER_DASHBOARDS"
},
{
"id": "VIEW_HOSTS"
},
{
"id": "EDIT_HOSTS"
},
{
"id": "VIEW_AGENTS"
},
{
"id": "EDIT_SCHEDULED_REPORTS"
},
{
"id": "VIEW_AUTHENTICATION_CONFIG"
},
{
"id": "EDIT_SHARED_DASHBOARDS"
},
{
"id": "DASHBOARD"
},
{
"id": "VIEW_SHARED_DASHBOARD_URLS"
},
{
"id": "VIEW_WEBHOOK_CONFIG"
}
],
"email": "[email protected]",
"type": "DEFAULT",
"authStatus": "ACTIVE",
"domain": "",
"upn": ""
}
]
401
The request was refused because it lacks valid authentication
credentials. This can happen if the Authorization header
was missing, or if it contained an invalid session ID.
Obtain a new session ID and retry the request,
or make an unauthenticated request without the Authorization header.
"Invalid session ID"
440
The request was refused because the session ID has
expired. Obtain a new session ID from /api/v1/sessions.
"Login Timeout"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v1/users