List Users

get

https://{hostname}/scim/v1/Users

Use this endpoint to get the list of users.

Query Params

sortBy

string

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

sortOrder

string

enum

Defaults to ascending

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

Allowed:

startIndex

integer

Defaults to 1

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.

count

integer

Defaults to 100

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

attributes

string

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

excludedAttributes

string

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.

filter

string

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

Headers

string

enum

Defaults to application/scim+json

Generated from available response content types

Allowed:

Responses

401

The SCIM token is invalid.

Language

Credentials

Bearer

URL

Response

Choose an example:

application/scim+json

application/json

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