API ReferenceManagementTenantsSCIM
GET
/scim/v2/Groups

Authorization

Descope Project ID:Access Key
AuthorizationBearer <token>

Project ID:Access Key as bearer token.

In: header

Query Parameters

filter?string
startIndex?integer
Formatint32
count?integer
Formatint32
excludedAttributes?string

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

curl -X GET "https://api.descope.com/scim/v2/Groups"
{  "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",      "status": 0    }  ],  "detail": "string",  "status": 0}
export interface Response {totalResults?: numberstartIndex?: numberitemsPerPage?: numberschemas?: string[]Resources?: {displayName?: stringschemas?: string[]id?: stringmembers?: {value?: stringdisplay?: string}[]meta?: SCIMGroupResourceMetaexternalId?: stringdetail?: stringstatus?: number}[]detail?: stringstatus?: number}export interface SCIMGroupResourceMeta {created?: {}location?: stringlastModified?: {}resourceType?: string}
Was this helpful?
SparklesAsk AI about this pageArrowRight

SCIM Management API Overview

Use the Descope API to manage your tenants' SCIM configurations with a management key.

Create SCIM Group POST

### Create a SCIM group, using a valid access key. This endpoint allows administrators to create new SCIM groups within their environement. When creating the group, you can configure the groupId, displayName, and it's members. The response includes the new group's group 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 created the group, you can later add or remove users from the SCIM groups via [Update SCIM Group](/api/management/tenants/scim/update-scim-group). ### See also - See [SCIM Management](/scim) for further details on managing SCIM provisioning.