List users

Retrieves a list of users based on the provided query parameters. Scoped OAuth requires: users.read

Authorization

apiKey bearerToken

Authorization<token>

A General Access API Key with format Token token=<API_KEY>

In: header

AuthorizationBearer <token>

An App OAuth Token with format Bearer <TOKEN>

In: header

Query Parameters

startIndex?integer

The 1-based index of the first result.

count?integer

Specifies the desired maximum number of query results per page.

filter?string

A filter expression to apply to the query. The only supported filters are by userName and externalId.

Response Body

`application/scim+json`

curl -X GET "https://example.com/Users?startIndex=1&count=100&filter=userName+eq+%22user%40example.com%22"

{  "Resources": [    {      "active": false,      "displayName": "Fake User",      "entitlements": [        {          "type": "license",          "value": "PABC123"        }      ],      "externalId": "00ujl29u0le5T6Aj10h7",      "id": "AGKWDNQ24N4SXBBWYENPROSIYQ",      "meta": {        "resourceType": "User"      },      "roles": [        {          "primary": true,          "type": "base",          "value": "user"        }      ],      "schemas": [        "urn:ietf:params:scim:schemas:core:2.0:User"      ],      "timezone": "America/New_York",      "title": "Software Developer",      "userName": "fake.user@example.com"    }  ],  "itemsPerPage": 1,  "schemas": [    "urn:ietf:params:scim:api:messages:2.0:ListResponse"  ],  "startIndex": 1,  "totalResults": 1}

List users

Authorization

Query Parameters

Response Body

200application/scim+json

400application/scim+json

401application/scim+json

403application/scim+json

500application/scim+json

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`