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

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://docs.omni.co/feedback

```json
{
  "path": "/administration/authentication/okta/user-attributes",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# Syncing Okta user attributes to Omni with SCIM

> Sync user attributes from Okta to Omni via SCIM.

Custom user attributes can be synced from Okta to Omni, allowing you to fully centralize your user management in Okta.

In this guide, we'll demonstrate how to sync a user attribute named `blob_entity` from Okta to Omni.

## Requirements

To follow the steps in this guide, you'll need:

* **To set up SCIM provisioning with Okta**. Refer to the [Omni Okta SCIM guide](/administration/authentication/okta/scim) for more information.
* **Organization Admin** permissions in Omni
* **Permissions in Okta** that allow you to:
  * Access the Admin console
  * Create user profile attributes
  * Define user profile attribute values
  * Modify applications

## Limitations

Omni [system user attributes](/administration/users/attributes#default-system-user-attributes) are read-only and cannot be assigned via SCIM.

## Setup

<Steps>
  <Step title="Create an Omni user attribute">
    In Omni, navigate to **Settings > Attributes** and [create a new attribute](/administration/users/attributes).

    Our example attribute, `blob_entity`, has the following settings:

    * **Name** - `Blob Entity`
    * **Reference** - `blob_entity`
    * **Type** - `string`

          <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-omni-attribute-6b49af33e3ab53f59d41617070ecad7f.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=cb5e78081c2ce23a7ad89ad16215f7b6" alt="" width="477" height="616" data-path="images/docs/administration/saml/okta/assets/images/okta-omni-attribute-6b49af33e3ab53f59d41617070ecad7f.png" />
  </Step>

  <Step title="Create & define an Okta user profile attribute">
    Click the dropdowns to display instructions for each step.

    <Accordion title="2.1. Create the attribute">
      <Tip>
        **Passing a default Okta attribute?**

        Creating an attribute is required **only** if the attribute you want to pass to Omni doesn't exist in [Okta's default user attributes](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/#tag/User/operation/createUser!path=profile\&t=request), such as `name` or `city`.
      </Tip>

      1. Log in to your Okta Admin console.

      2. Navigate to **Directory > Profile Editor**.

      3. Click the **User (default)** option.

      4. Click the **Add Attribute** button.

      5. Fill in the attribute fields as follows:

         * **Data type** - Select the **Type** the attribute has in Omni. For example, if the attribute has a **Type** of `string` in Omni, you'd select `string`.
         * **Display name** - Enter a name for the attribute.
         * **Variable name** - Enter the **Reference** for the attribute in Omni. In our example, this would be `blob_entity`.
         * **Enum** - If the Omni attribute can have multiple values, check this box and use the fields that display to add the possible values.

      6. Omni doesn't require a specific configuration for the remaining fields; feel free to define them as needed.

      7. When finished, click **Save**.

               <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-profile-attribute-fca69e82161aca20282f02fae022f4a4.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=e4a412b31215553b804ee30b38a2b12e" alt="" width="535" height="929" data-path="images/docs/administration/saml/okta/assets/images/okta-profile-attribute-fca69e82161aca20282f02fae022f4a4.png" />
    </Accordion>

    <Accordion title="2.2. Define attribute values">
      After you create the attribute, **open the profile of each user assigned to the Omni application** and define a value for the attribute. Refer to the [Okta documentation](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-edit-user-attributes.htm) if you need a refresher on how to do this.

      <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-user-profile-attribute-4522818e09ceaf3ac73ffc75b316bded.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=caa31312b169ecad555857279b6b61bc" alt="" width="1400" height="949" data-path="images/docs/administration/saml/okta/assets/images/okta-user-profile-attribute-4522818e09ceaf3ac73ffc75b316bded.png" />
    </Accordion>
  </Step>

  <Step title="Create an Omni application attribute">
    1. In Okta, navigate to **Directory > Profile Editor**.

    2. Click the **Omni application**.

    3. Click **Add Attribute**.

    4. Fill in the attribute fields as follows:

       * **Data type** - Select the **Type** the attribute has in Omni. For example, if the attribute has a **Type** of `string` in Omni, you'd select `string`.
       * **Display name** - Enter a name for the attribute.
       * **Variable name** - Enter the **Reference** for the attribute in Omni. In our example, this would be `blob_entity`.
       * **External name** - This will auto-populate based on the **Variable name**
       * **External namespace** - Copy and paste the following into this field:
         ```txt theme={null}
         urn:omni:params:1.0:UserAttribute
         ```
         **This value must be this exact string - don't change the `UserAttribute`.**
       * **Enum** - If the Omni attribute can have multiple values, check this box and use the fields that display to add the possible values.

    5. Click **Save**.

           <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-add-attribute-c4cc5b4aed3a4f75aab506a81edbfcf3.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=de742e02490c8536ccb46be173c95e90" alt="" width="597" height="420" data-path="images/docs/administration/saml/okta/assets/images/okta-add-attribute-c4cc5b4aed3a4f75aab506a81edbfcf3.png" />
  </Step>

  <Step title="Map the user & application attributes">
    The last step is to map the Okta profile attribute to the Omni application attribute.

    1. In the profile editor for the Omni application, click the **Mappings** button:

           <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-mapping-button-78e0edea1831d796fdebc89f6a40db6f.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=d9b1f82ec88b94d8a561ef8403afe851" alt="" width="782" height="280" data-path="images/docs/administration/saml/okta/assets/images/okta-mapping-button-78e0edea1831d796fdebc89f6a40db6f.png" />

    2. In the dialog that displays, toggle the view to **Okta User to Omni Analytics**:

           <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-attribute-mapping-1c2e0fc58dddb47bd2e297e0a96ecb3c.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=424b8d254036c7d5ef356019759f6e5c" alt="" width="805" height="423" data-path="images/docs/administration/saml/okta/assets/images/okta-attribute-mapping-1c2e0fc58dddb47bd2e297e0a96ecb3c.png" />

    3. Use the dropdowns to map the attributes to each other. In our example, the `user.blobEntity` attribute on the **Omni user profile** side is mapped to the `blobEntity` attribute on the **Omni Analytics User Profile** side.

    4. Use the **arrows** in the middle of the dialog to set the attribute to **Apply mapping on user create and update**:

           <img src="https://mintcdn.com/omni-e7402367/pGnmRvM0SVfXp3bi/images/docs/administration/saml/okta/assets/images/okta-attribute-update-31138713292b5b6bd21ec64278f015c2.png?fit=max&auto=format&n=pGnmRvM0SVfXp3bi&q=85&s=d23d75cb37fd03ac5c591696087111bb" alt="" width="616" height="164" data-path="images/docs/administration/saml/okta/assets/images/okta-attribute-update-31138713292b5b6bd21ec64278f015c2.png" />

    5. When finished, click **Save Mappings**.
  </Step>
</Steps>

## What's next?

At this point, there are two things left:

* **Syncing the attributes to Omni**. You can do this by:

  * **Waiting for Okta to perform the next automatic sync**, or
  * **Forcing a manual sync**. Open the Okta Omni application, click the **Provisioning** tab, and scroll down to the **Attributes** section. Click the **Force Sync** button to trigger a sync.

* **Defining attribute values**. When you do this, use the **user profile attribute** you created in Okta in step 2. The mapping between this attribute and the one in the Okta Omni application will allow the value to flow through to your Omni instance.

  If you need a refresher on how to do this, refer to the [Okta documentation](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-edit-user-attributes.htm).
