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

# Setup SCIM

> Enable real-time user and group provisioning from Microsoft Entra ID to Vikat Enterprise using SCIM 2.0.

SCIM (System for Cross-domain Identity Management) keeps Vikat in sync with Entra in real time - new users are provisioned, deactivated users are suspended, and group memberships are updated without waiting for the next login or background sync.

<Note>
  Complete [SSO using OIDC](./oidc) before setting up SCIM. SCIM runs as a **separate** provisioning job alongside your existing OIDC integration.
</Note>

***

## Step 1: Enable SCIM in Vikat

<Steps>
  <Step title="Open your Entra provider">
    In your Vikat dashboard, go to **Governance** → **User Provisioning** and open your configured Microsoft Entra provider.
  </Step>

  <Step title="Enable SCIM provisioning">
    Click the settings icon to open **Provider Configuration**.

    Toggle on **Enable SCIM Provisioning** and click **Save & Enable**.
  </Step>

  <Step title="Copy the SCIM credentials">
    After saving, Vikat shows a **Setup Complete** dialog with:

    * **SCIM Endpoint URL** - the base URL Entra will send provisioning requests to
    * **Provisioning Token** - the bearer token Entra uses to authenticate

    Copy both values now - you will need them in [Step 2](#step-2-configure-entra-provisioning).

    <Warning>
      The provisioning token is only shown once. Store it somewhere safe before closing this dialog. You can always rotate it later, but the previous token will immediately become invalid.
    </Warning>
  </Step>
</Steps>

***

## Step 2: Configure Entra provisioning

<Steps>
  <Step title="Open the Provisioning tab">
    In the [Azure Portal](https://portal.azure.com), go to **Microsoft Entra ID → Enterprise applications → Vikat Enterprise**.

    Open the **Provisioning** tab and click **Get started**.
  </Step>

  <Step title="Set the provisioning mode and credentials">
    Set **Provisioning Mode** to **Automatic**.

    Under **Admin Credentials**, enter:

    | Field            | Value                                                              |
    | ---------------- | ------------------------------------------------------------------ |
    | **Tenant URL**   | The SCIM Endpoint URL from [Step 1](#step-1-enable-scim-in-vikat)  |
    | **Secret Token** | The Provisioning Token from [Step 1](#step-1-enable-scim-in-vikat) |

    Click **Test Connection** to verify, then **Save**.
  </Step>

  <Step title="Configure attribute mappings (optional)">
    Expand **Mappings** to review or adjust how Entra user and group attributes are mapped to SCIM fields that Vikat receives.

    The default mappings cover standard fields (name, email, active status, groups). Skip this step unless you need to sync custom attributes.

    <Accordion title="Syncing custom profile attributes (e.g. employeeId, department, costCenter)">
      To include a custom attribute in the SCIM payload Entra sends to Vikat:

      1. Under **Mappings**, click **Provision Microsoft Entra ID Users**
      2. Click **Add New Mapping**
      3. Set the **Source attribute** to the Entra user property (e.g. `employeeId`, `department`)
      4. Set the **Target attribute** to the corresponding SCIM attribute name (e.g. `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber`)
      5. Click **Ok** and **Save**

      Back in Vikat, go to **Attribute Mapping** in the provider setup and add a **SCIM Attribute** entry using the same attribute name. The name must match exactly - including case.
    </Accordion>
  </Step>

  <Step title="Enable provisioning">
    Back on the main Provisioning settings page, set **Provisioning Status** to **On** and click **Save**.
  </Step>
</Steps>

***

## Step 3: Assign users and groups

<Steps>
  <Step title="Assign users or groups to the application">
    Go to **Enterprise applications → Vikat Enterprise → Users and groups**.

    Click **Add user/group** and select the users or groups you want to provision into Vikat.

    <Note>
      Only users and groups explicitly assigned to the application are provisioned when the provisioning scope is set to **Sync only assigned users and groups** (the default). Set scope to **Sync all users and groups** only if you want to provision your entire directory.
    </Note>

    Assigned users are pushed to Vikat during the next provisioning cycle (typically within 40 minutes). When a user is unassigned or disabled in Entra, Vikat deactivates them in real time.
  </Step>

  <Step title="Trigger an on-demand sync (optional)">
    To provision a specific user immediately without waiting for the next cycle, go to the **Provisioning** tab and click **Provision on demand**.

    Search for the user, select them, and click **Provision**.
  </Step>
</Steps>

***

## Step 4: Verify in Vikat

Once provisioning is active, confirm everything is syncing correctly.

* Go to **Governance** → **Users** to see provisioned users and their assigned roles
* Go to **Governance** → **Teams** to see teams populated from synced groups
* Go to **Governance** → **Business Units** to see business units resolved from group or attribute mappings

Changes in Entra - new assignments, group membership updates, deactivations - will reflect in Vikat within the provisioning cycle (typically 40 minutes for incremental cycles, up to 4 hours for the initial cycle).

***

## How sync works

**Initial cycle** - on first enable, Entra performs a full sync of all in-scope users and groups. This can take up to 4 hours for large directories.

**Incremental cycles** - after the initial sync, Entra pushes only changes (new users, deactivations, attribute updates, group membership changes) every \~40 minutes.

**Background reconciliation** - Vikat also runs a full reconciliation from the Microsoft Graph API every 24 hours to catch anything the SCIM push may have missed.

***

## Troubleshooting

**Test Connection fails** - verify the Tenant URL has no trailing slash and the Secret Token matches exactly what Vikat generated. Rotate the token in Vikat and update Entra if needed.

**Users are provisioned but have no role** - SCIM provisions the user record; role assignment comes from attribute mappings in the OIDC provider. Confirm your Attribute-to-Role mappings are configured and the relevant claims are present in the JWT at login time.

**Custom attribute is not arriving in Vikat** - confirm the SCIM attribute name in Entra's mapping and Vikat's SCIM Attribute setting match exactly (case-sensitive). Verify the mapping was saved under **Provision Microsoft Entra ID Users**.

**Group membership is not syncing** - groups must be assigned to the Enterprise Application and provisioning scope must include groups. Check that **Provision Microsoft Entra ID Groups** is enabled under **Mappings**.

**Users are stuck in "Pending"** - this is normal during the initial cycle for large directories. Check the **Provisioning logs** under **Monitoring** in the Provisioning tab for per-user status and any errors.