SCIM provisioning module
/
SCIM configurations
/
Create a SCIM configuration

SCIM Provisioning Overview

The SCIM Provisioning endpoints enable seamless management of user identities and groups in compliance with the SCIM (System for Cross-domain Identity Management) standard. This service supports automatic provisioning and deprovisioning of user accounts, ensuring data synchronization across multiple identity providers and applications.

Fully compliant with SCIM 2.0, the SCIM Provisioning Service guarantees compatibility and interoperability across various identity platforms.

This section lists all relevant API endpoints, organized into Management and Self-Service categories:

Management Endpoints: Require environment-level authorization and offer comprehensive control over SCIM resources.

Self-Service Endpoints: Accessible with a user token (JWT) and allow users with the necessary permissions to create, update, and delete a SCIM connection on their account.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
Languages
Servers
EU Region
https://api.frontegg.com/directory/
US Region
https://api.us.frontegg.com/directory/
CA Region
https://api.ca.frontegg.com/directory/
AU Region
https://api.au.frontegg.com/directory/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/directory/

SCIM settings

Operations

SCIM configurations

Operations

Create a SCIM configuration

Request

Create a provisioning (SCIM) configuration for an account (tenant).

Headers
frontegg-tenant-idstring

The tenant ID identifier

Bodyapplication/jsonrequired
sourcestringrequired
Enum"frontegg""okta""azure-ad""other"
connectionNamestring
syncToUserManagementboolean
curl -i -X POST \
  https://api.frontegg.com/directory/resources/v1/configurations/scim2 \
  -H 'Content-Type: application/json' \
  -d '{
    "source": "frontegg",
    "connectionName": "string",
    "syncToUserManagement": true
  }'

Responses

Bodyapplication/json
idstringrequired
connectionNamestringrequired
tokenstringrequired
Response
application/json
{
  "id": "string",
  "connectionName": "string",
  "token": "string"
}

Get a SCIM configuration by ID

Request

Get a provisioning (SCIM) configuration by its ID.

Path
idstringrequired
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/directory/resources/v1/configurations/scim2/{id}'

Responses

Bodyapplication/json
idstringrequired
tenantIdstringrequired
connectionNamestringrequired
sourcestringrequired
syncToUserManagementbooleanrequired
lastSyncstring or null(date-time)required
createdAtstring(date-time)required
Response
application/json
{
  "id": "string",
  "tenantId": "string",
  "connectionName": "string",
  "source": "string",
  "syncToUserManagement": true,
  "lastSync": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Update a SCIM configuration

Request

Create a provisioning (SCIM) configuration for an account (tenant).

Path
idstringrequired
Headers
frontegg-tenant-idstring

The tenant ID identifier

Bodyapplication/jsonrequired
syncToUserManagementbooleanrequired
curl -i -X PATCH \
  'https://api.frontegg.com/directory/resources/v1/configurations/scim2/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "syncToUserManagement": true
  }'

Responses

Delete a SCIM configuration

Request

Create a provisioning (SCIM) configuration for an account (tenant).

Path
idstringrequired
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X DELETE \
  'https://api.frontegg.com/directory/resources/v1/configurations/scim2/{id}'

Responses