GET
/scim/v2/Users

Search SCIM users, using a valid access key.

This endpoint allows administrators to search SCIM users. These users have been created and associated to the Application and Descope tenant.

The response includes an array of user objects within the Resources object. These user objects include details about the users including their email, phone, username, name, etc.

It is important to note the bearer token for SCIM API endpoints. The format is ProjectId:AccessKey the access key must be associated with the applicable tenant and associated with the tenant admin role.

Next Steps

Once you have user data, you can utilize Update SCIM Group to add or remove the user on groups.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:AccessKey\>

Try it

/scim/v2/Users

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Access Key > as bearer

In: header

Query Parameters

filterstring

startIndexinteger

Format: "int32"

countinteger

Format: "int32"
Status codeDescription
200OK
curl -X GET "https://api.descope.com/scim/v2/Users?filter=string&startIndex=0&count=0" \
  -H "Authorization: Bearer <ProjectId:AccessKey>"

{
  "totalResults": 0,
  "startIndex": 0,
  "itemsPerPage": 0,
  "schemas": [
    "string"
  ],
  "Resources": [
    {
      "schemas": [
        "string"
      ],
      "id": "string",
      "userName": "string",
      "meta": {
        "created": {},
        "location": "string",
        "lastModified": {},
        "resourceType": "string"
      },
      "emails": [
        {
          "value": "string",
          "primary": true,
          "type": "string"
        }
      ],
      "name": {
        "givenName": "string",
        "familyName": "string",
        "middleName": "string"
      },
      "active": true,
      "displayName": "string",
      "detail": "string",
      "attributes": {}
    }
  ],
  "detail": "string",
  "status": 0
}

Was this helpful?

Next

Overview