API ReferenceManagementTenantsSCIM
GET
/scim/v2/Groups/{groupId}

Load an existing SCIM group, using a valid access key.

This endpoint allows administrators to load an existing SCIM group using the SCIM groupId, which is a required field, and optionally the displayName.

The response includes the group's object which includes 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 associated with the tenant admin role.

Next Steps

Once you have this data, 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/{groupId}

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Access Key > as bearer

In: header

Path Parameters

groupId
Required
string

Query Parameters

displayNamestring

externalIdstring

excludedAttributesstring

Status codeDescription
200OK
curl -X GET "https://api.descope.com/scim/v2/Groups/{groupId}" \
  -H "Authorization: Bearer <ProjectId:AccessKey>"

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

Was this helpful?

Previous

Create SCIM Group

Next

Update SCIM Group