Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Users

List Users

Use this endpoint to get the list of users.

get/Users

Query parameters

sortBystring
Example:displayName

The 'sortBy' parameter specifies the attribute whose value is used to order the returned responses.

sortOrder'ascending' | 'descending'

The order in which the 'sortBy' parameter is applied. Defaults to ascending.

startIndexinteger

A pagination parameter. It is the 1-based index of the first query result. A value less than 1 will be rounded up to 1.

countinteger

A pagination parameter. Specifies the desired maximum number of query results per page. A negative value will be rounded up to 0.

attributesstring

When included, each resource returned will contain the minimum set of resource attributes and any attributes or sub-attributes explicitly requested.

excludedAttributesstring

When included, each resource returned will contain the minimum set of resource attributes. Additionally, the default set of attributes minus those attributes listed in "excludedAttributes" is returned.

filterstring

When included, the resources must match the given criteria to be included in the response.

Response

Returns the list of users, optionally user attributes are filtered by attributes or excludedAttributes parameters.

itemsPerPageinteger

The number of resources returned in a list response page.

schemasstring[]

A schema for representing the resource list configuration.

startIndexinteger

The 1-based index of the first result in the current set of list results.

totalResultsinteger required

The total number of results returned by the list or query operation.

Example response

{
  "Resources": [
    {
      "locale": "en",
      "title": "Vice President"
    }
  ]
}