SCIM Management API Overview

Overview

The Descope service supports the ability to dynamically configure user data via SCIM (System for Cross-domain Identity Management). Descopers can configure SCIM provisioning from their IdP, which will then be able to push user profile updates as well as groups.

The Descope API then opens endpoints to load, create, update, and delete SCIM-related configurations. The Descope SDK does not support the same SCIM endpoints as the API.

Use Cases

Managing SCIM Groups

1. Search SCIM groups
2. Create SCIM group
3. Load an existing SCIM group
4. Update an existing SCIM group
5. Delete an existing SCIM group

Managing SCIM Users

1. Search SCIM users
2. Load an existing SCIM user
3. Update an existing SCIM user
4. Delete an existing SCIM user

Gathering SCIM Configuration

1. Load SCIM Resource Types
2. Load SCIM Service Provider Config

Examples

Example - Create SCIM group and apply it to a SCIM user

Create a SCIM group via Create SCIM Group adding the member in the body of the request.

Example - Update SCIM user details

Update the SCIM user via Update SCIM User passing updated details such as the displayName, phoneNumbers, emails, and if the user is active.