{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/celonis-apis/scim-api/configuring-scim-api/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Configuring SCIM API

\n

System for Cross-domain Identity Management (SCIM), is a standard protocol designed to make it easier to manage user identities across various cloud-based applications e.g. your source identity system and your Celonis Platform team. It provides a common user schema and an API for automating the exchange of user identity information. SCIM's focus is on simplicity and fast integration, supporting scenarios like creating, updating, and deleting user accounts and groups automatically.

\n

For more information about SCIM, go to scim.cloud.

\n

Enabling SCIM

\n

To enable SCIM for your Celonis Platform team:

\n
    \n
  1. \nGo to \nAdmin & Settings > Settings\n and then switch on the \nEnable SCIM\n toggle.\n

    \n \n \n

    \n

    Note

    \n

    SCIM can only be enabled if Just-in-time (JIT) user provisioning is disabled. See Configuring SAML JIT single sign-on.

    \n
    2. \n
  2. \nAdd an OAuth client to authorize your identity system access to the SCIM API.\n
      \n
    1. \nGo to \nAdmin & Settings > Applications\n and follow the process described in \nRegistering your OAuth client in Celonis Platform\n to add a new OAuth client application.\n
      2. \n
    2. \nWhen asked to define scopes, select \"user-provisioning.scim\".\n
      3. \n
    3. \nGive your OAuth client SCIM permissions by going to \nAdmin & Settings > Permissions > User Provisioning\n.\n
      4. \n
    \n
    3. \n
  3. \nIn your identity provider's settings, use the credentials that you created in the previous step and the following URL:\n
    \n
    \n
    Copy
    \n
    Copied
    \n
    \n 
    [https://[Team-Name].[Realm].celonis.cloud/scim/v2/]
    \n
    \n
    4. \n
\n

SCIM Schema

\n

These are the attributes of the SCIM Schema we are using for the user and group resource. The SCIM protocol is defined in RFC 7643.

\n

SCIM User Resource

\n

For provisioning users, we are using attributes that are present in the default SCIM user schema (urn:ietf:params:scim:schemas:core:2.0:User) and attributes in our custom SCIM user extension (urn:ietf:params:scim:schemas:extension:celonis:3.0:User). For the explanation of individual attributes, see the following:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeExplanationRequiredSchema
userNameThis has to be an email that belongs to a mailbox for verifying the address. This field is used to verify the user who wants to login.yesdefault
displayNameThe name will be shown in the Celonis Platform.recommendeddefault
externalIdThis is an ID you may provide for your own reference.recommendeddefault
activeIndicates if the user may log in. Defaults to true.nodefault
nameIf displayName is not provided this will be used instead.nodefault
roleThe role of the user in Celonis Platform - \"MEMBER\", \"ANALYST\" or \"ADMIN\". The default value is \"MEMBER\".nocustom
sendEmailOnInvitationWhen inviting a new user, this controls whether or not the user should receive an invitation email. For example, this can be used if you want to send your own custom e-mails at your own pace.nocustom
\n

SCIM Group Resource

\n

For provisioning groups, we are using attributes that are present in the default SCIM group schema: (urn:ietf:params:scim:schemas:core:2.0:Group) and attributes in our custom SCIM group extension: (urn:ietf:params:scim:schemas:extension:celonis:3.0:Group). In the following table, the attributes are explained.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributeExplanationRequiredSchema
displayNameThis defines the group name in Celonis Platform and must be unique for your team.yesdefault
externalIdThis is an ID you may provide for your own reference.recommendeddefault
membersA list of members of the group. One list element contains key-value pairs. The \"value\" key attribute is required and defines the ID of the user in our source system (this is not the externID).nodefault
roleThe role of the group in Celonis Platform - \"MEMBER\", \"ANALYST\" or \"ADMIN\". The default value is \"MEMBER\".nocustom
\n

Additional resources

\n

For additional help configuring SCIM or to see which SCIM endpoints are available, refer to the API documentation provided. To access this API documentation, copy the URL below and replace [Team-Name] and [Realm] with the corresponding details from your instance:

\n
\n
\n
Copy
\n
Copied
\n
\n 
[https://[Team-Name].[Realm].celonis.cloud/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config&urls.primaryName=SCIM](null)
\n
","headings":[{"value":"Configuring SCIM API","depth":1},{"value":"Enabling SCIM","depth":2},{"value":"SCIM Schema","depth":2},{"value":"SCIM User Resource","depth":3},{"value":"SCIM Group Resource","depth":3},{"value":"Additional resources","depth":3}]},"contentItem":{"data":{"lastModified":"2025-09-03T18:42:42.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"521b642c-7a9b-5d53-8502-a1d840a543e5__redocly content/celonis-apis/scim-api/configuring-scim-api/","seo":{"title":"Configuring SCIM API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/scim-api/configuring-scim-api.md","pageBaseUrl":"/celonis-apis/scim-api/configuring-scim-api","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Configuring SCIM API","id":"configuring-scim-api"},{"depth":2,"value":"Enabling SCIM","id":"enabling-scim"},{"depth":2,"value":"SCIM Schema","id":"scim-schema"},{"depth":3,"value":"SCIM User Resource","id":"scim-user-resource"},{"depth":3,"value":"SCIM Group Resource","id":"scim-group-resource"},{"depth":3,"value":"Additional resources","id":"additional-resources"}]},"data":{"title":""},"catalogInfo":null,"link":"/celonis-apis/scim-api/configuring-scim-api/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}