API ReferenceManagementTenantsSCIM
GET
/scim/v2/Groups

Search SCIM groups, using a valid access key.

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

The response includes an array of group objects within the Resources object. These group objects include details about the groups including the members.

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 has the tenant admin role.

Next Steps

Once you have this data, you can Update an Existing SCIM Group or Delete an Existing SCIM Group. You can add or remove users from the SCIM groups via Update SCIM Group.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:AccessKey\>

Try it

/scim/v2/Groups

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"

excludedAttributesstring

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

{
  "totalResults": 0,
  "startIndex": 0,
  "itemsPerPage": 0,
  "schemas": [
    "string"
  ],
  "Resources": [
    {
      "displayName": "string",
      "schemas": [
        "string"
      ],
      "id": "string",
      "members": [
        {
          "value": "string",
          "display": "string"
        }
      ],
      "meta": {
        "created": {},
        "location": "string",
        "lastModified": {},
        "resourceType": "string"
      },
      "externalId": "string",
      "detail": "string"
    }
  ],
  "detail": "string"
}

Was this helpful?

Previous

SCIM Management API Overview

Next

Create SCIM Group