> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iru.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SCIM Directory Integration

> Set up SCIM-based user directory synchronization in Iru Endpoint. Automatically provision and deprovision users and groups from your identity provider.

### About SCIM Directory Integration

SCIM, or the [System for Cross-domain Identity Management](https://scim.cloud/), is a protocol designed to make managing user identities across different systems simpler and more efficient. It's particularly useful when you're using multiple cloud-based applications, as it helps automate the process of adding and removing users.

### How It Works

SCIM involves two main roles:

* **Client** - This is usually an identity provider or identity access management system, like Microsoft Entra ID or Okta, that manages core identity data.
* **Service Provider** - A software-as-a-service (SaaS) application, like Iru Endpoint, that uses identity data to manage user access and permissions.

SCIM supports several operations, including provisioning, synchronization, and deprovisioning. This one-way sync allows you to automatically create user accounts in Iru Endpoint, keep user attributes up-to-date between your MDM and IdP, and automatically remove or disable user accounts when they are no longer needed.

### Configuring SCIM in Iru Endpoint

To configure a SCIM integration between your Identity Provider (IdP) and Iru Endpoint, you will need to:

* Create a new SCIM Directory Integration in Iru Endpoint
* Obtain the SCIM API URL and API token from Iru Endpoint to use with your IdP.
* Access your IdP to create an app integration, map SCIM attributes, and push desired user groups.

#### Creating a New SCIM Directory Integration

<Steps>
  <Step title="Open Integrations">
    In Iru Endpoint, in the sidebar, click the [**Account Menu Button**](/en/iru/platform-overview/account-menu), then select **Integrations**.

    <Frame>
      <img src="https://mintcdn.com/iru/8BYPjuKZa-zyEEf_/assets/media/images/iru-nav-integrations.png?fit=max&auto=format&n=8BYPjuKZa-zyEEf_&q=85&s=e89fa7e9b81ac504a6f519608e10b8a3" alt="Screenshot of the account menu with Integrations option highlighted" width="562" height="1040" data-path="assets/media/images/iru-nav-integrations.png" />
    </Frame>
  </Step>

  <Step title="Discover Integrations">
    Click **Discover integrations** in the upper-right of the Integrations page.
  </Step>

  <Step title="Add SCIM Protocol">
    On the **SCIM protocol** tile, click **Add and configure**.

    <Frame>
      <img src="https://mintcdn.com/iru/ceHzuGddI7w_43xJ/assets/media/images/iru-add-configure-scim.png?fit=max&auto=format&n=ceHzuGddI7w_43xJ&q=85&s=c55030a21c30ef6f65dc90285d3c45d7" alt="Add new integration page with SCIM protocol tile and Add and configure button" width="2134" height="1284" data-path="assets/media/images/iru-add-configure-scim.png" />
    </Frame>
  </Step>

  <Step title="Start Configuration">
    Click **Get started**.
  </Step>

  <Step title="Name the Integration">
    Enter a unique name for the SCIM integration.
  </Step>

  <Step title="Generate Authentication Token">
    Click **Generate token**. The SCIM user directory integration uses an HTTP authorization header with a Bearer Token as the authentication method.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-name.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=cf4df5d3d63147de7739024f71f94bf8" alt="Configure a SCIM user integration screen with name field and Generate token button" width="1898" height="1258" data-path="assets/media/images/iru-scim-name.png" />
    </Frame>
  </Step>

  <Step title="Copy the Token">
    Click **Copy token**.
  </Step>

  <Step title="Confirm Token Copy">
    The token will not be visible again after you click Done. Store it securely before continuing.
  </Step>

  <Step title="Complete Setup">
    Confirm that you have copied the token by checking the box, then click **Done**. You will return to the **Integrations** page.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-copy-token.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=c31e71ca70b13bd8db22047685ff47ae" alt="Copy token and configure with your identity provider dialog with Copy token button" width="1912" height="1262" data-path="assets/media/images/iru-scim-copy-token.png" />
    </Frame>
  </Step>
</Steps>

#### Obtaining the SCIM API URL

Your SCIM API URL is available from the integration details in Iru Endpoint. You will need to provide this URL to your identity provider when configuring the SCIM connection.

<Steps>
  <Step title="Access Integration Details">
    Click the **ellipsis** on the SCIM directory integration you just created.
  </Step>

  <Step title="View Details">
    Select **View Details**.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-view-details.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=f70aee81eba7ce75589cb220c68cce65" alt="Directory integrations list with SCIM integration and ellipsis menu showing View details, Rename, Rotate token, Delete" width="1162" height="542" data-path="assets/media/images/iru-scim-view-details.png" />
    </Frame>
  </Step>

  <Step title="Copy API URL">
    **Copy** the SCIM API URL (e.g. `https://subdomain.api.iru.com/api/v1/scim`). Your identity provider will require this.

    <Note>The URL displayed in your tenant may still show the `api.kandji.io` domain. The `api.kandji.io` version of the SCIM API URL will also work for this purpose.</Note>
  </Step>

  <Step title="Close Details">
    Click **Close**.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-copy-api-url.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=f826bc146ef440fff34093ffeb0202d6" alt="View user integration details modal with SCIM API URL and copy button" width="1258" height="804" data-path="assets/media/images/iru-scim-copy-api-url.png" />
    </Frame>
  </Step>
</Steps>

### Renaming a SCIM Integration

To change the name of an existing SCIM directory integration:

<Steps>
  <Step title="Open the integration menu">
    Click the **ellipsis** on the SCIM directory integration you want to rename.
  </Step>

  <Step title="Choose Rename">
    Select **Rename**.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-rename.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=636f5a240bc0da3818af803221fd6116" alt="SCIM integration ellipsis menu with Rename option" width="1158" height="542" data-path="assets/media/images/iru-scim-rename.png" />
    </Frame>
  </Step>

  <Step title="Enter the new name">
    Enter the new name for the integration and save.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-rename-prompt.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=8bce3f3a702cc1044918b75de8937961" alt="Rename SCIM integration prompt or dialog with name field" width="1270" height="674" data-path="assets/media/images/iru-scim-rename-prompt.png" />
    </Frame>
  </Step>
</Steps>

### Rotating the SCIM Token

Rotate the SCIM API token when you need to invalidate the current token (for example, after a security concern or when reconfigured in your IdP). After rotating, update the new token in your identity provider.

<Steps>
  <Step title="Open the integration menu">
    Click the **ellipsis** on the SCIM directory integration.
  </Step>

  <Step title="Choose Rotate token">
    Select **Rotate token**.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-rotate-token.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=f8f63aedfd798b4a2c0d08f6d96f5cbc" alt="SCIM integration ellipsis menu with Rotate token option" width="1160" height="534" data-path="assets/media/images/iru-scim-rotate-token.png" />
    </Frame>
  </Step>

  <Step title="Confirm the rotation">
    Confirm the rotation in the prompt. The previous token will no longer work.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-rotate-prompt.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=8a4ba4bc590415c8380c2a21848455ac" alt="Rotate token confirmation prompt for SCIM integration" width="1106" height="674" data-path="assets/media/images/iru-scim-rotate-prompt.png" />
    </Frame>
  </Step>

  <Step title="Copy the new token">
    Copy the new token and update it in your IdP.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-copy-new-token.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=12bfb79182832a84389e2f1d57f67013" alt="Copy the new SCIM token after rotation" width="1098" height="1282" data-path="assets/media/images/iru-scim-copy-new-token.png" />
    </Frame>
  </Step>
</Steps>

### Deleting a SCIM Integration

Removing a SCIM directory integration stops synchronization from your IdP and removes the integration from Iru Endpoint. Update or remove the SCIM app in your IdP to avoid errors.

<Steps>
  <Step title="Open the integration menu">
    Click the **ellipsis** on the SCIM directory integration you want to remove.
  </Step>

  <Step title="Choose Delete integration">
    Select **Delete integration**.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-delete-integration.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=4f85eb0691b2e64e4cb7a0b2c44a7179" alt="SCIM integration ellipsis menu with Delete integration option" width="1158" height="536" data-path="assets/media/images/iru-scim-delete-integration.png" />
    </Frame>
  </Step>

  <Step title="Confirm deletion">
    Confirm that you want to delete the integration in the prompt.

    <Frame>
      <img src="https://mintcdn.com/iru/09oHsghqQ24xDtMY/assets/media/images/iru-scim-delete-prompt.png?fit=max&auto=format&n=09oHsghqQ24xDtMY&q=85&s=fd94a0d15d035bb5c9b6468ef97b0662" alt="Delete SCIM integration confirmation prompt" width="1108" height="728" data-path="assets/media/images/iru-scim-delete-prompt.png" />
    </Frame>
  </Step>
</Steps>

### SCIM Schema and Supported Attributes

Iru Endpoint supports the following SCIM attributes. Refer to these attributes when mapping your SCIM application in your IdP.

<Note>
  Iru Endpoint does not use any attributes that are not in the list below. To limit the attributes sent, please modify the attributes configured in the SCIM app in your IdP.
</Note>

**User attributes**

| **Attribute**  | **Description**                                                                                                 | **Required** |
| -------------- | --------------------------------------------------------------------------------------------------------------- | ------------ |
| userName       | Unique identifier for the user, used to authenticate to the service provider                                    | Yes          |
| name.formatted | The user's full name (for example, "John Doe"). This attribute or the displayName attribute is required         | No           |
| displayName    | The user's full name (for example, "John Doe"). This attribute or the name.formatted attribute is required      | Yes          |
| title          | The user's title, such as "Vice President."                                                                     | No           |
| active         | The user's status within the identity provider. This attribute is automatically added by the Identity Provider. | Yes          |
| emails.value   | The user's email address as a subattribute of emails. Iru Endpoint only stores the first email in the list.     | Yes          |
| department     | Identifies the name of a department.                                                                            | No           |

**Group attributes**

| **Attribute** | **Description**                      | **Required** |
| ------------- | ------------------------------------ | ------------ |
| displayName   | A human-readable name for the Group. | Yes          |
| members       | A list of members in the Group.      | Yes          |

When using SCIM to sync users from a directory, the SCIM app automatically sends new information to Iru Endpoint, so there is no need for a Sync Now button that you would see when using the native Entra ID or Google Workspace directory integrations. Each cloud IdP has its own standard for syncing SCIM data.

Please check with your identity provider's documentation to understand how SCIM sync is configured.

### Related Articles

Configure SCIM in your identity provider using the article for your IdP. Iru Endpoint's SCIM implementation follows the SCIMv2 specification.

<CardGroup cols={3}>
  <Card title="SCIM Directory Integration with Okta" icon="key" href="/en/endpoint/integrations/scim/scim-directory-integration-with-okta">
    Connect Okta to Iru Endpoint for automatic user and group provisioning via SCIM
  </Card>

  <Card title="SCIM Directory Integration with Microsoft Entra ID" icon="microsoft" iconType="brands" href="/en/endpoint/integrations/scim/scim-directory-integration-with-microsoft-entra-id">
    Connect Microsoft Entra ID (Azure AD) to Iru Endpoint for SCIM-based user and group provisioning
  </Card>

  <Card title="SCIM Directory Integration with OneLogin" icon="key" href="/en/endpoint/integrations/scim/scim-directory-integration-with-onelogin">
    Connect OneLogin to Iru Endpoint for automatic user and group provisioning via SCIM
  </Card>
</CardGroup>
