Skip to content

Compatibility

This page details the SCIM attributes and operations used by Digidentity. The information here can be used to confirm whether a SCIM application will be compatible with Digidentity's SCIM API.

A more detailed description of each component can be found in the SCIM specification.

Required SCIM attributes

The following table outlines the required attributes for integrating with the Digidentity platform via the SCIM 2.0 protocol. These attributes are essential for user provisioning, onboarding, offboarding, and access management.

For a seamless integration, ensure each attribute is correctly mapped.

SCIM 2.0 attribute name Attribute properties Mapping description
User.id required, immutable, string, anchor Unique identifier of User in IGA System
User.userName string, immutable, required, matching attribute Has to be mapped to default User email address, used for onboarding and matching users between IGA and Digidentity
User.active boolean, mutable, required Used for off-boarding and soft-deletion operations
User.roles string, mutable, multivalued, required
Sub-attributes: Role.value – string, required		 Used for provisioning access to products provided by Digidentity

Supported SCIM Operations

For our full technical specification, please visit https://docs.digidentity.com/

Create User

  • Request: POST /Users
  • Description: Creates a new user with attributes such as userName, active, and roles.
  • Response: HTTP 201 Created with the created user details.

Get User Details

  • Request: GET /Users/{id}
  • Description: Retrieves details of a user by their unique ID.
  • Response: HTTP 200 OK with user details, or 404 Not Found if the user doesn't exist.

Search Users

  • Description: Retrieves a list of users based on search criteria.

Get All Users

  • Request: GET /Users
  • Response: HTTP 200 OK with a list of users.

Get Users by Email

  • Request: GET /Users?filter=userName eq "example@user.com"
  • Response: HTTP 200 OK with matching user details, or empty if no match found.

Update User Attributes

  • Request: PATCH /Users/{id}
  • Description: Updates specific user attributes.

Replace User Roles

  • Operation: replace user roles.
  • Response: HTTP 204 No Content

Add User Roles

  • Operation: add new roles.
  • Response: HTTP 204 No Content

Remove User Roles

  • Operation: remove roles based on criteria.
  • Response: HTTP 204 No Content

Disable User

  • Operation: replace active attribute to false (soft deletion).
  • Response: HTTP 204 No Content

Delete User

  • Request: DELETE /Users/{id}
  • Description: Deletes a user by their unique ID.
  • Response: HTTP 204 No Content

Schema Discovery

  • Request: GET /Schemas
  • Description: Retrieves schema details for user resources.
  • Response: HTTP 200 OK with schema information.

Service Provider Configuration

  • Request: GET /ServiceProviderConfig
  • Description: Retrieves the service provider's configuration, including supported SCIM features.
  • Response: HTTP 200 OK with configuration details.