Introduction

Unique AI provides SCIM compliant endpoints to be able to connect an IDP via the SCIM protocol. This protocol defines a standard for managing groups and users across multiple applications. An IDP is therefore able to sync its users and groups with other applications which supports this standard protocol.
The SCIM integration has been tested thoroughly with Microsoft Entra ID. This documentation guides through the setup process for Microsoft Entra ID.

Setup

This setup guide leads you through the process of connecting the Microsoft Entra ID application with Unique AI

[Zitadel] Adjusting permission of service user

This chapter is only required or to be confirmed if you maintain the Zitadel instance. Skip this part in case Unique maintains the tenant for you.

The service user which until now synced the changes from Zitadel (events) with Unique AI requires now more privileges (IAM Owner Viewer & IAM User Manager). This service user now needs to also be able to create, modify and delete users from any organisation on Zitadel via API (IAM User Manager). But also fetch information about Organisations to be able to assign roles and IDPs to new created users (IAM Owner Viewer).
The service user also needs to be a service user of the Cluster IAM organisation (The organisation which has the Unique project created). Otherwise the role assignments will not work.

1. Login to Zitadel with a user that has IAM Owner capabilities (instance manager).

2. Switch to Cluster IAM organisation on top left.

3. Switch to the instance view on top right.

4. Open the instance users managing view.

5. There should be a service user (robot icon) which has currently at least

   IAM Owner Viewer capability called user-sync or scope-management-user.

5. Adjust the Permission of this user including IAM Owner Viewer and IAM User Manager

[MS Portal] Creating the SCIM Enterprise Application

These screenshots will guide you through the process of creating an Enterprise Application for SCIM.

1. Microsoft Entra ID resource

2. Enterprise Applications

3. New Enterprise Application

4. Own Application

5. Name and Type

6. Finished

[MS Portal] Adding Users/Groups to the Application

In this step you define which users or groups are getting synced with Unique AI.

1. Adding users/groups

2. Selecting users/groups

3. Assigned users/groups

[Unique API] Creating the SCIM key

To be able to connect Microsoft Entra ID to Unique AI an API-Key is required. A user with the “Chat.Admin.All” role is able to run the following curl. This will create a key, which is authorised to access the SCIM endpoints of Unique AI for the organisation the user belongs to.

curl --location 'https://gateway.<baseUrl>/scope-management/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your-access-token>' \
--data '{"query":"mutation ScimKeyCreate {\n  scimKeyCreate {\n    id\n    key\n  }\n}","variables":{}}'

In the response you will find the key attribute. Store this in a save place you will not be able to get it again but you can create a new one and delete old ones. The key will be used for the next step “[MS Portal] Connecting the Provisioning“.

[MS Portal] Connecting the Provisioning

With generating an API-key to access the SCIM endpoints of Unique AI (created in the step before “[Unique API] Creating the SCIM key“) it is possible to connect now the Microsoft Entra ID with Unique AI.

1. Switch to Provisioning

2. Add Configuration

3. Fill URL and Token

The <API-URL> is the base API URL on which the Unique AI backend services are available. Normally its something similar like: https://gateway.xxx.unique.app. But especially for customer managed tenant this can vary.

4. Test and create

5. Adjust the attribute mapping

6. Modify externalId to ObjectId

Please verify the user mapping. Especially the mapping from externalId → objectId.

If you want to send custom user Metadata, then also check out this guide with its metadata mapping: User and Group metadata provisioning via SCIM

7. Start Provisioning

Hint: When you apply SCIM provisioning on a tenant that has already users on it we recommend to first start provisioning specific users (a new one and an existing one). This should show if the provisioning works. Also check on Zitadel differences between the newly added user and the existing ones. Adjust the User mapping then when there are differences in the user name for example.

Read here more about SSO Setup: How To Setup Single Sign-On (SSO)