BEbeyondidentity
SCIM

List All Users

To list all users, send a GET request to /Users.

Currently, filtering on users only supports the eq and ne operators and the userName and externalId attributes.

The response will contain at most 1000 items. If count is not specified or is zero, the response will not contain any resources. There is no defined ordering of the list of users in the response. Note that the maximum page size is subject to change.

get/scim/v2/Users

Request

Query parameters

filterstring
Example:displayName eq "John Doe"

Filter for list methods.

Filters follow the SCIM grammar from RFC 7644 Section 3.4.2.2.

countinteger

Specifies the desired maximum number of query results per page. A negative value is treated as 0, which indicates that the response should not contain any resources. Note that the response may include fewer results than the requested count.

startIndexinteger

The 1-based index of the first query result.

Response

The response will be a ListResponse containing the users corresponding to the request. The totalResults key may be used to determine whether there are additional pages to fetch for the request.

schemasstring[] required

The list of schemas used to define the list response. This only contains the ListResponse schema ("urn:ietf:params:scim:api:messages:2.0:ListResponse").

totalResultsinteger required

Total number of results matching the request. This value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available.

startIndexinteger required

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

itemsPerPageinteger required

The number of resources returned in a list response page.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
      "externalId": "external-id-abcdef",
      "userName": "test_user",
      "displayName": "Test User",
      "active": true,
      "emails": [
        {
          "primary": true,
          "value": "test@test.com",
          "type": "work"
        }
      ],
      "name": {
        "givenName": "Barbara",
        "familyName": "Jensen"
      },
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "employeeNumber": "10.164682/g9j6r80"
      },
      "groups": [
        {
          "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
          "$ref": "../Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
          "type": "direct"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2022-04-07T07:23:33Z",
        "lastModified": "2023-03-30T07:00:14Z",
        "location": "Groups/ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
        "version": "W/0"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.