# SailPoint Okta SaaS Connector Documentation > Okta SaaS Connector Documentation # Documentation # Connecting SailPoint and Okta SaaS To connect SailPoint with Okta, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings Your source needs to authenticate with the Okta managed system to connect and interact with it. The process to configure authentication changes depending whether you authenticate with an API Token or OAuth 2.0. > [!IMPORTANT] > > CIEM does not support OAuth 2.0 for Okta SaaS connections. Configure the connection using an **API Token**. For more information, refer to [Authenticate with OAuth 2.0](<#authenticate-with-oauth-20>). ### Authenticate with an API Token Configure your source to authenticate with Okta using an API Token. > [!NOTE] > > **Screenshot** > > [![API Token]()]() 1. Enter the **Okta URL** of the host. For example, `https://{yourOktaDomain}.com`. 2. Select the **API Token** radio button. 3. In the **API Token** field, enter the SSWS API token required for Okta authentication. > **Note** > > SSWS specifies the proprietary authentication scheme Okta uses. 4. Select **Save**. ### Authenticate with OAuth 2.0 Configure your source to authenticate with Okta using OAuth 2.0. > [!NOTE] > > For more information on retrieving some of the credentials used in this process, refer to [Implement OAuth for Okta with a Service App](). > [!NOTE] > > **Screenshot** > > [![OAuth 2.0]()]() [![OAuth 2.0]()]() > [!NOTE] > > The Okta managed system does not support aggregation of the `type_name` and `type_displayName` attributes with OAuth 2.0 authentication type. SailPoint recommends that you use **API token** authentication to aggregate these attributes. For more information, refer to [Authenticate with an API Token](<#authenticate-with-an-api-token>). 1. Enter the **Okta URL** of the host. For example, `https://{yourOktaDomain}.com`. 2. Select **Client Credentials** for the **Grant Type**. Currently, this is the only grant type supported. 3. Enter the **OAuth 2.0 Token URL** for token generation. For example: `https://{yourOktaDomain}/oauth2/v1/token` 4. Enter the **Scopes** that must be included while creating JWT token for appropriate operations on the Okta managed system. Scopes must be provided as a space-separated value. For example: | Operation | Scopes | | --- | --- | | Mandatory Scopes | okta.logs.read okta.users.manage okta.groups.manage okta.appGrants.read okta.apiTokens.read | 5. Enter the **JWT Header** that has the algorithm being used for signing the JWT assertion. For example: ```json { "typ": "JWT", "alg": "RS256" } ``` 6. Enter the JWT **Client ID** for authorization. This value must be the same as the `client_id` of the Okta application. 7. Enter the **Private Key** text in Privacy Enhanced Mail (PEM) format to encrypt the JWT assertion. > **Important** > > If your private key was originally provided in the JWK format, you need to convert it to PEM format before entering it. 8. Enter the **Private Key Password** to decrypt the private key that was used for assertion. > **Note** > > The private key password may be referenced as a "KID" or KEY ID in Okta. 9. Select **Save**. ## Change Authentication from API Token to OAuth 2.0 If the Authentication Type is set to **API Token**, you can change the authentication type to OAuth 2.0 by performing the following: 1. Add the `private_key`, `private_key_password`, and `accessToken` attributes to the encrypted tag with the connector-encrypted key, using the REST API. Refer to [REST API - Update Source (Partial)](). 2. Remove the `type_name` and `type_displayName` attributes from account schema if they are present. ## Machine Identity Governance Settings Use these settings to control which Okta applications are aggregated into datasets. **To configure application aggregation:** 1. Go to **Machine Identity Governance Settings**. 2. Select the **Aggregate OpenID Connect Applications Only** checkbox to aggregate only OpenID Connect applications. This checkbox is selected by default. Clear the checkbox to aggregate all application types. 3. Select **Save**. ## Activity Insights Settings SailPoint pulls in activity data in the form of events like user logins, password changes, and content updates within the application. You can view an identity’s activity data within an application to discover trends for that user. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on utilizing activity data, refer to [Activity Insights](). Activity Insights Settings allows you to gather account information and activity data from Okta. To enable Activity Insights for the Okta application, refer to [Prerequisites]() for more information. To configure Activity Insights, complete the following: > [!NOTE] > > **Screenshot** > > [![Activity Insights Settings]()]() 1. Go to **Activity Insights Settings**. 2. Select **Enable Activity Insights** to view access to data insights on source and application activity such as logins and other app-specific events. 3. Select **Save**. ## Aggregation Settings Configure how your source handles aggregation. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() [![Aggregation Settings]()]() [![Aggregation Settings]()]() ### Filter Settings > [!NOTE] > > For custom attribute filters to work, you must ensure the option to **Enable List Users With Search** is selected. Set the condition to filter out the accounts and groups in the respective fields. #### Filter Conditions for Accounts For example, if the added filter is `status eq "STAGED"` then only the `staged` accounts are aggregated. Refer to the following table: | Filter | Description | | --- | --- | | `status eq "STAGED"` | Users that have a status of STAGED | | `status eq "PROVISIONED"` | Users that have a status of PROVISIONED | | `status eq "ACTIVE"` | Users that have a status of ACTIVE | | `status eq "RECOVERY"` | Users that have a status of RECOVERY | | `status eq "PASSWORD_EXPIRED"` | Users that have a status of PASSWORD\_EXPIRED | | `status eq "LOCKED_OUT"` | Users that have a status of LOCKED\_OUT | | `status eq "DEPROVISIONED"` | Users that have a status of DEPROVISIONED | | `lastUpdated lt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Users last updated before a specific timestamp | | `lastUpdated eq "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Users last updated at a specific timestamp | | `lastUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Users last updated after a specific timestamp | | `id eq "00u1ero7vZFVEIYLWPBN"` | Users with a specified ID | | `profile.login eq "login@example.com"` | Users with a specified login | | `profile.email eq "email@example.com"` | Users with a specified email address | | `profile.firstName eq "John"` | Users with a specified firstName | | `profile.lastName eq "Smith"` | Users with a specified lastName | | `profile.Custom_Integer_Array eq "23"` | Users with a specified array attribute | | `profile.Custom_String eq "Custom Value for String__Updated"` | Users with a specified custom attribute | #### Filter Conditions for Groups This setting is optional however it is available by default. The filter brings a subset of groups during aggregation, for example `type eq "OKTA_GROUP"`. The default filter (`type eq "BUILT_IN" or type eq "OKTA_GROUP"`) only aggregates Okta and built-in groups. | Filter | Description | | --- | --- | | `type eq "OKTA_GROUP"` | Groups that have a type of OKTA\_GROUP | | `type eq "APP_GROUP"` | Groups that have a type of APP\_GROUP | | `type eq "BUILT_IN"` | Groups that have a type of BUILT\_IN | | `lastUpdated lt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with profile last updated before a specific timestamp | | `lastUpdated eq "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with profile last updated at a specific timestamp | | `lastUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with profile last updated after a specific timestamp | | `lastMembershipUpdated lt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with memberships last updated before a specific timestamp | | `lastMembershipUpdated eq "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with memberships last updated at a specific timestamp | | `lastMembershipUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ"` | Groups with memberships last updated after a specific timestamp | | `id eq "00g1emaKYZTWRYYRRTSK"` | Group with a specified ID | For the full list of supported filters, including Application filters and filter combination examples, refer to [Supported Aggregation Filters](). ### Delta Aggregation > [!NOTE] > > The Okta SaaS connector supports delta aggregation for accounts only. Enable **Delta Aggregation** to aggregate new accounts or the accounts that have been changed since the last aggregation. > [!NOTE] > > For new sources delta aggregation is enabled by default. Refer to [Configuring Delta Aggregations for Supported Sources]() for more details on how to configure delta aggregations on a supported source. Refer to [Delta Aggregation]() to understand more about the behavior of delta aggregation in Okta SaaS. ### Page Size Settings 1. Enter the **User Page Size**. This is the maximum size of each dataset when querying large number of objects. Default: 200. Minimum value: 1. Maximum value: 200. 2. Enter the **Group Page Size** value. This is the maximum size of each dataset while querying a large number of Groups. Default: 10000. Minimum value: 1. Maximum value: 10000. 3. Enter the **Logs Page Size** value. This is the maximum size of each dataset while querying large number of Logs. Default: 1000. Minimum value: 1. Maximum value: 1000. 4. Select **Save**. ### Additional Settings > [!NOTE] > > **Screenshot** > > [![Additional Settings]()]() 1. Enter the **API Rate Limit** for the maximum API rate limit threshold as the maximum permissible call number. If you have the `maxPermissibleCalls` attribute, you can change its value. This value is expressed as a percentage without the percent symbol (%). By default, it is `90`. 2. Select **Disable Group Caching** to disable the cache creation of user groups. The connector fetches user profiles followed by groups during account aggregation. The Okta source creates a group cache to improve aggregation performance, as exemplified in the following steps: 1. The source creates a cache of users connected to groups. 2. The source then fetches the user profiles. 3. The source maps the groups of the fetched user profiles to the cache created originally. This cache creation works best in environments where there are fewer connections between users and groups. Because of API limitations, the cache creation can take a longer time the more connections there are. To skip the cache creation and fetch the user profiles followed by groups, enable the option to **Disable Group Caching**. 3. Select **Enable Group Skinny User** to enable the `skinny_user` endpoint to fetch the groups connected to a user in the Okta source. This attribute is applicable only for caching the approach of account aggregation. 4. Select **Enable List Users With Search** to run account aggregation with Okta's **List Users with Search** feature. By default, the Okta source supports the managed system's **List Users with Filter** feature for account aggregation. The **List Users with Search** feature searches for users based on the properties specified in the search parameter (case insensitive). This operation supports pagination to a maximum of 50000 results. #### Partitioning Settings > [!NOTE] > > **Screenshot** > > [![Partitioning Settings]()]() Select the option to **Enable Partitioning** to process the data in parallel across multiple threads. 1. Enter a **Number of Partitioning Threads** value. By default, it is 2. 2. Select **Save**. ## Provisioning Settings Use this setting to configure how the connector updates accounts when you disable them in SailPoint. Account changes are provisioned to the source using the selected method. > [!NOTE] > > **Screenshot** > > [![Provisioning Settings]()]() To configure provisioning settings, complete the following: 1. Under **Disable Operation Setting**, select one of the following: - Select **Suspend** to temporarily disable the account. - Select **Deprovision** to remove all applications from the account and deactivate it. Enable **Send Email** to send a deactivation email to the Okta's administrator email address. 2. Select **Save**. ## SailPoint CIEM Settings SailPoint's Cloud Infrastructure Entitlement Management (CIEM) enhances identity governance by providing a deeper view into the effective access of entitlements to resources and your users' entitlement activity in your cloud infrastructure. > [!IMPORTANT] > > You must have a SailPoint Cloud Infrastructure Entitlement Management (CIEM) license to enable cloud governance features. Contact your SailPoint Customer Success Manager to request access. For more information on CIEM Cloud Governance, refer to [CIEM Cloud Governance Overview](). CIEM settings allows you to collect cloud resource data and display the total access an identity has to your cloud systems. ### Prerequisites - Before enabling CIEM and adding your Application IDs, you need to configure Okta to work with CIEM. For more information on these steps, refer to [Configuring Okta for SailPoint CIEM](). - To enable SailPoint CIEM for the Okta SaaS connector, you must configure API Token authentication. CIEM does not support OAuth 2.0 authentication, and using it will cause test connection errors. To configure CIEM, complete the following: > [!NOTE] > > **Screenshot** > > [![CIEM Settings]()]() 1. Go to **CIEM Settings**. 2. Select **Enable Cloud Infrastructure Entitlement Management (CIEM)** to view access to cloud resources and infrastructure granted through entitlements. 3. Enter the **Application ID** for the configured Okta instance. Separate multiple entries with a comma. 4. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Delta Aggregation > [!NOTE] > > The Okta SaaS connector supports delta aggregation for accounts only. The time stamp for account aggregation is stored in the application object and is used by the delta aggregation feature to aggregate updated data into SailPoint. This time stamp is updated after every account delta aggregation. The delta for Okta user profile attributes is populated from the users API by comparing the time stamp of the last successful account aggregation against the last updated attribute. To detect entitlement changes and deleted users, the data is populated from the logs API by comparing the time stamp of the last successful account aggregation against the published attribute. > [!NOTE] > > Log data older than 90 days is not returned by Okta's Data Retention Policy. This implies that any data changes that happened before 90 days from the last successful account aggregation will not be captured and hence a full account aggregation will be required. # Integrating SailPoint with Okta SaaS > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. This SailPoint connector manages Okta accounts using a REST API provided by Okta. This document is designed to give specific information about requirements and field definitions needed to configure a working instance of an Okta source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features Refer to [Supported Features]() for more information. ## Prerequisites - The Okta source must manage Users, Groups, and Roles using the REST API provided by Okta. By default, the `applications` attribute is not a part of the account schema. To add this attribute to the existing schema, refer to [Adding Attributes to a Source Schema](). ### For API Token Authentication An administrative user must be granted an Okta API token to authenticate. > [!NOTE] > > Okta API tokens generated from these steps are valid for 30 days and automatically refresh with each API call. Tokens that are not used for 30 days will expire. To generate an Okta API token: 1. Go to [Create an API token]() in the Okta Developer documentation. 2. Sign in to your Okta organization as a user with super administrator privileges. API tokens have the same permissions as the user who creates them. If the user permissions change, the API token permissions also change. 3. On the Developer Console, select **Tokens** from the API menu. 4. On the administrator's UI (Classic UI), go to **Security \> API \> Tokens**. 5. Select **Create Token** and provide a name for the token. 6. Note the API token for future references. ### For OAuth 2.0 Authentication To use Okta OAuth 2.0 authentication: 1. Create a service application in Okta. > **Note** > > For information on creating a service application on Okta, refer to [Implement OAuth for Okta with a service app]() in the Okta Developer documentation. 2. Grant the required OAuth scopes to the service application. 3. Configure the Okta source as per the detail of service application. > **Note** > > Refer to [Authenticate with OAuth 2.0]() for OAuth 2.0 configuration. ## Required Permissions Create an Okta account with privileges to manage the Okta accounts you want to aggregate. Okta provides different levels of permission that provide create, update, and delete account capability. Review the permission model below and create your account accordingly. Generate the Okta API token with this account that can be used for authentication. For example, you can create an account with Super Admin/Org Admin/Group Admin permissions. | Connector Operation | Super Admin | Org Admin | Group Admin | App Admin | Read-only Admin | Help-desk Admin | | --- | --- | --- | --- | --- | --- | --- | | Test Connection | Yes | Yes | Yes | Yes | Yes | Yes | | Aggregate Standard Attributes | Yes | Yes | Yes | Yes | Yes | Yes | | Aggregate Groups Attribute | Yes | Yes | No | Yes | Yes | No | | Aggregate Roles Attribute | Yes | No | No | No | No | No | | Aggregate Factors Attribute | Yes | Yes | Yes | No | Yes | Yes | | Aggregation of Custom Roles | Yes | No | No | No | No | No | | Aggregation of Applications | Yes | No | No | Yes | Yes | No | | Delta Aggregation | Yes | Yes | No | Yes | Yes | No | | Create Users | Yes | Yes | Yes | No | No | No | | Enable/Disable Users | Yes | Yes | Yes | No | No | No | | Unlock Accounts | Yes | Yes | Yes | No | No | Yes | | Password Resets/Change password | Yes | Yes | Yes | No | No | No | | Pass-through Authentication | Yes | Yes | Yes | Yes | Yes | Yes | | Management of APP Target and APP Instance Target for APP\_ADMIN Role | Yes | No | No | No | No | No | | Management of Group Target for HELP\_DESK\_ADMIN Role | Yes | No | No | No | No | No | | Add/Remove Groups | Yes | Yes | No | No | No | No | | Add/Remove Applications | Yes | No | No | Yes | No | No | | Add/Remove Roles | Yes | No | No | No | No | No | | Create/Update/Delete group | Yes | Yes | No | No | No | No | | Operation | Scopes | | --- | --- | | Mandatory Scopes | okta.logs.read okta.users.manage okta.groups.manage okta.appGrants.read okta.apiTokens.read | | Additional Scopes to Manage Roles | okta.roles.manage | | Additional Scopes to Manage Factors | okta.factors.manage | | Additional Scopes to Manage Applications | okta.apps.manage | | Additional Scopes for Discover Schema | okta.schemas.manage | ### Activity Insights An administrator requires the following additional permissions to utilize the Activity Insights: | Scope | Description | | --- | --- | | okta.apps.read | Allows read-only access to application in your Okta organization. | | okta.groups.read | Allows read-only access to group information in your Okta organization. | | okta.logs.read | Allows read-only access to system log in your Okta organization. | | okta.users.read | Allows read-only access to existing user profile information in your Okta organization. | For more information on configuring Activity Insights, refer to [Activity Insights Settings](). # Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. ## Machine Account Provisioning Attributes | Create Account Attribute | Description | | --- | --- | | Login | Okta username / unique login identifier for the new user. | | Email | Primary email on the Okta user profile. | | First name | First name on the Okta user profile. | | Last name | Last name on the Okta user profile. | # Provisioning The Okta SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in Okta directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes The following generators create required information for a new Okta account. You might need to edit the contents. | Account Attribute | Generator | Description | | --- | --- | --- | | login | Identity Attribute | Unique ID (username) used as login | | email | Identity Attribute | Primary Email of the user | | firstName | Identity Attribute | First name of the user | | lastName | Identity Attribute | Last name of the user | | activate | Static Value | Checked to set the status as provisioned, unchecked to set status as staged | | password | Generator | Login password for the user | | middleName | Disable | Middle name(s) of the user | | secondEmail | Disable | Secondary email address of the user that is used for account recovery | | displayName | Disable | The display name that can be used for the user | | title | Disable | User's title. For example: "Sr. General Manager" | | honorificPrefix | Disable | Honorific prefix(es) of the user. For example: "Dr., Mrs., Mr." | | honorificSuffix | Disable | Honorific suffix(es) of the user. For example: "MD, PhD, MSCSW" | | profileUrl | Disable | URL of the user's Online profile | | primaryPhone | Disable | Primary phone number of the user | | mobilePhone | Disable | Mobile phone number of user | | streetAddress | Disable | Street address component of the user's address | | city | Disable | City or locality component of the user's address | | state | Disable | State or region component of the user's address | | zipCode | Disable | ZIP code or postal code component of the user's address | | countryCode | Disable | Country name component of the user's address | | postalAddress | Disable | Mailing address component of the user's address | | preferredLanguage | Disable | The user's preferred written or spoken language | | locale | Disable | The user's default location for the purpose of localizing items such as currency, date/time format, numerical representations, etc. | | timezone | Disable | The user's time zone | | userType | Disable | Used to identify the type of the user, such as "Employee" or "Contractor" | | employeeNumber | Disable | Unique identifier for the user assigned by the organization or company | | costCenter | Disable | Cost center assigned to the user | | organization | Disable | The user's organization | | division | Disable | The user's division | | department | Disable | The user's department | | manager | Disable | The name of the user's manager | | managerId | Disable | ID of the user's manager | | providerName | Disable | The name of the credential provider | | providerType | Disable | The type of the credential provider | > [!NOTE] > > Custom attributes of the User profile from Okta can be populated using the Discover Schema functionality. The Okta Source supports the Credential Provider User (for example, Federation/Social Provider user) in the Okta managed system. Users with a FEDERATION or SOCIAL authentication provider do not support a password credential and must be authenticated using a trusted Identity Provider. While creating an Okta user, if the `providerName` attribute is not configured or an invalid value is provided, both the provider type and name are set as `OKTA`. ## Account Status To verify the status of the created user, refer to the following table. | Activate Checkbox | Password | Provider Type | Status on the Okta Managed System | Source Status | | --- | --- | --- | --- | --- | | Unchecked | Provided/Not Provided | Empty | STAGED | Disabled | | Checked | Not Provided | Empty | Pending user action | Enabled | | Checked | Provided | Empty | PASSWORD\_EXPIRED | Enabled | | Unchecked | Not Provided | FEDERATION/SOCIAL | STAGED | Disabled | | Checked | Not Provided | FEDERATION/SOCIAL | ACTIVE | Enabled | ## Assignment of User Type While Creating a User The Okta Source now supports assignment of a user type while creating a user in the Okta managed system. Also, the source supports aggregation of the type of the user with `type_name` and `type_displayName` attributes that define the name and display name of the assigned user type, respectively. You must manually add the `type_name` and `type_displayName` attributes to the account schema. Refer to this document: [Adding Attributes to a Source Schema](). In the **Create Account** section of the Okta source UI, set up the following attribute. | Account Attribute | Generator | Description | | --- | --- | --- | | type\_name | Disable | The name of the Okta user type. This `type_name` attribute is case-sensitive and it is referred to as 'variable name' of user type in the managed Okta system. | ## Additional Information This section contains information on additional attributes you can use to set up your provisioning policy. The Okta connector now supports a configurable delay for single-account aggregation prior to executing update operations. To configure this delay, add the following entry to the source XML using the REST API: ```text Patch https://{orgName}.api.identitynow.com/v2025/sources/{OktasourceID} ``` In the body of the Patch, use the form-data as follows: ```json { "op": "add", "path": "/connectorAttributes/connector_waitBeforeGetObject ", "value": "20" } ``` ### Custom Attributes To provision custom attributes you have created in the Okta system, add a matching attribute into the provisioning policy. For example, if you have the custom attributes; `customAttr1` and `customAttr2` on Okta and you need to provision them, you need to add `customAttr1` and `customAttr2` to the provisioning plan as well. To add custom attributes, refer to [Adding Attributes to Create Account Page for Sources](). ### Account Status The following table contains information on the status of created accounts: | Activate Checkbox | Password | Status on the Okta Managed System | Source Status | | --- | --- | --- | --- | | false | Provided/Not Provided | STAGED | Disabled | | true | Not Provided | Pending user action | Enabled | | true | Provided | PASSWORD\_EXPIRED | Enabled | By default, the activate field value in **Create Account** section is true. ### Account Status for Federation Provider The following table contains information on the attributes used to configure a federation provider. | Activate Checkbox | Password | Provider Type | Status on the Okta Managed System | Source Status | | --- | --- | --- | --- | --- | | Unchecked | Not Provided | FEDERATION/SOCIAL | STAGED | Disabled | | Checked | Not Provided | FEDERATION/SOCIAL | ACTIVE | Enabled | ### Support to Recovery Question and Answer in Provisioning The Okta source can provision a recovery question and answer along with an account in the Okta native system. Add the following attributes in the **Create Account** section in the Okta configuration interface for an Okta account. | Account Attribute | Generator | Description | | --- | --- | --- | | recoveryQuestion | Disable | The recovery question for the user | | recoveryAnswer | Disable | The answer for the recovery question | The following table contains information on the status of accounts. | Activate Checkbox | Password | Recovery Question and Answer | Status on the Okta Managed System | Source Status | | --- | --- | --- | --- | --- | | Unchecked | Provided | Not provided | STAGED | Disabled | | Checked | Not Provided | Provided | Pending user action | Enabled | | Checked | Provided | Provided | ACTIVE | Enabled | ### Send Email Updates for Enable Account Provisioning Policy When enabling a deprovisioned user, the system will not send an activation email to the user if the `sendEmail` attribute is set to `false` in the enable operation provisioning policy. The default value is `true`. > [!NOTE] > > For more information, contact [SailPoint Services](). ### Setting a Password in Permanent Mode The Okta source supports the ability to set a password in `Permanent` mode while creating a new account. In the Okta system, in the **Create Account** section, configure `setPasswordInPermanentMode`. Set the value to `true` for creation of an account in Active mode. It sets a password in `Permanent` mode for the newly created account. By default, an account is created in the `PASSWORD_EXPIRED` mode. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Okta SaaS connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Okta SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | login | Equals | Work Email | | email | Equals | Work Email | ## Identity Profile Mapping The Okta SaaS connector supports the following attributes in Identity Profile Mapping by default: | Identity Attribute | Schema Attribute | | --- | --- | | uid | id | | email | email | | displayName | login | | firstname | firstName | | lastname | lastName | | manager | manager | | personalEmail | secondEmail | | workPhone | mobilePhone | | phone | primaryPhone | | title | title | | department | department | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | id | Account | | groupId | Group | ### Default Account Attributes The Okta SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | id | The unique key for the user. This is an Account ID which must not be changed. | | login | The unique ID (username) used as the login | | email | The primary email of the user | | firstName | The first name of the user | | lastName | The last name of the user | | password | The login password for the user | | middleName | The middle name(s) of the user | | secondEmail | The secondary email address of the user that is used for account recovery | | displayName | The display name for the user | | nickName | The casual way to address the user in real life | | title | The user's title. For example, `Sr. General Manager` | | honorificPrefix | The honorific prefix(es) of the user. For example, `Dr., Mrs., Mr.` | | honorificSuffix | The honorific suffix(es) of the user. For example, `MD, PhD, MSCSW` | | profileUrl | The URL of the user's online profile | | primaryPhone | The primary phone number of the user | | mobilePhone | The mobile phone number of the user | | streetAddress | The full street address component of user's address | | city | The city or locality component of the user's address | | state | The state or region component of the user's address | | zipCode | The zip code or postal code component of the user's address. | | countryCode | The country name component of the user's address | | postalAddress | The mailing address component of the user's address | | preferredLanguage | The user's preferred written or spoken language | | locale | The user's default location for purposes of localizing items such as currency, date/time format, numerical representations, etc. | | timezone | The user's timezone | | userType | Used to identify the type of the user, such as `Employee` or `Contractor` | | employeeNumber | The unique identifier for the user that is assigned by the organization or company | | costCenter | The name of the cost center assigned to the user | | organization | The name of the user's organization | | division | The name of the user's division | | department | The name of the user's department | | manager | The name of the user's manager | | managerId | The ID of the user's manager | | status | The status of the user. For example, `Active`, `Provisioned`, or `Deprovisioned` | | created | The time stamp for when the user was originally created. | | statusChanged | The time stamp for when the status was last changed | | lastUpdated | The time stamp for when the user was last updated | | lastLogin | The time stamp of last login session | | passwordChanged | The time stamp for when the user's password was last changed | | providerName | The name of the credential provider | | providerType | The credential provider type | | roles | The standard roles assigned to the user | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Okta SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | groupId | The unique key for the group. This is an Account ID which must not be changed. | | name | The name of the group. | | created | The timestamp for when the group was created. | | description | The description of the group. | | lastMembershipUpdated | The timestamp for when the group's memberships were last updated. | | type | Indicates how a group's profile and memberships are managed. | | lastUpdated | The time stamp for when the group's profile was last updated. | | objectClass | The group's class, which determines the group's profile. | | applications | Applications assigned to group. To add this attribute to an existing schema, refer to [Adding Attributes to a Source Schema](). Use the [createSchema]() API to create a new group schema for your source. | ### Default Application Attributes By default, the `applications` attribute is not a part of the account schema. The `applications` attribute is a multi-valued, entitlement attribute associated with application group schema object type, and it aggregates the applications assigned to a user. > [!NOTE] > > `applications` is an account schema attribute and `application` is an entitlement schema object type. The following is a list of `application` attributes. | Attribute Name | Description | | --- | --- | | applicationId | Unique key for the application. | | name | Unique key for the application definition. | | label | Unique user-defined display name for the application. | | created | Timestamp for when the application was created. | | status | Status of the application. | | signOnMode | Authentication mode of the application. | | features | Enabled application features. | | lastUpdated | Timestamp for when the application was last updated. | # Supported Aggregation Filters Based on the configured Accounts or Groups Aggregation Filter, only the respective accounts or groups are aggregated into SailPoint. ## Account Aggregation Filters Configure a filter to define the scope of aggregated accounts. For example, if the added filter is `status eq "STAGED"` then only staged account will be aggregated into SailPoint. > [!NOTE] > > Custom attributes can only be captured by filters when **Enable List Users With Search** is enabled. | Aggregation Filters | Description | | --- | --- | | status eq "STAGED" | Users that have a status of STAGED | | status eq "PROVISIONED" | Users that have a status of PROVISIONED | | status eq "ACTIVE" | Users that have a status of ACTIVE | | status eq "RECOVERY" | Users that have a status of RECOVERY | | status eq "PASSWORD\_EXPIRED" | Users that have a status of PASSWORD\_EXPIRED | | status eq "LOCKED\_OUT" | Users that have a status of LOCKED\_OUT | | status eq "DEPROVISIONED" | Users that have a status of DEPROVISIONED | | lastUpdated lt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Users last updated before a specific timestamp | | lastUpdated eq "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Users last updated at a specific timestamp | | lastUpdated gt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Users last updated after a specific timestamp | | id eq "00u1ero7vZFVEIYLWPBN" | Users with a specified ID | | profile.login eq "[login@example.com]()" | Users with a specified login | | profile.email eq "[email@example.com]()" | Users with a specified email\* | | profile.firstName eq "John" | Users with a specified firstName\* | | profile.lastName eq "Smith" | Users with a specified lastName\* | | profile.Custom\_Integer\_Array eq "23" | Users with a specified array attribute\* | | profile.Custom\_String eq "Custom Value for String\_\_Updated" | Users with a specified custom attribute\* | ## Group Aggregation Filters By default, the group Aggregation filter aggregates `type eq "OKTA_GROUP"` or `type eq "BUILT_IN"` groups. | Aggregation Filters | Description | | --- | --- | | type eq "OKTA\_GROUP" | Groups that have a type of OKTA\_GROUP | | type eq "APP\_GROUP" | Groups that have a type of APP\_GROUP | | type eq "BUILT\_IN" | Groups that have a type of BUILT\_IN | | lastUpdated lt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups whose profile was last updated before a specific timestamp | | lastUpdated eq "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups whose profile was last updated at a specific timestamp | | lastUpdated gt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups whose profile was last updated after a specific timestamp | | lastMembershipUpdated lt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups whose memberships were last updated before a specific timestamp | | lastMembershipUpdated eq "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups with memberships which were last updated at a specific timestamp | | lastMembershipUpdated gt "yyyy-MM-dd'T'HH🇲🇲ss.SSSZ" | Groups with memberships which were last updated after a specific timestamp | | id eq "00g1emaKYZTWRYYRRTSK" | Group with a specified ID | ## Account Status Mapping The following table lists the mapped status of Okta on SailPoint. | Okta Account Status | SailPoint Account Status | | --- | --- | | PROVISIONED | Enabled | | PASSWORD\_EXPIRED | Enabled | | ACTIVE | Enabled | | RECOVERY | Enabled | | DEPROVISIONED | Disabled | | SUSPEND | Disabled | | STAGED | Disabled | | LOCKED\_OUT | Locked | ## Application Aggregation Filters Configure a filter to define the scope of aggregated applications. Configuring this filter is optional. For more information, refer to [Additional Configurations](). | Aggregation Filters | Description | | --- | --- | | status eq "INACTIVE" | Users that have a status of INACTIVE | | status eq "ACTIVE" | Users that have a status of ACTIVE | ## Combinations of Filters Multiple aggregation filters can be combined using the AND and OR operators to create more complex queries. | Filters | Example Filter Expression | Description | | --- | --- | --- | | Account Aggregation Filters | status eq "ACTIVE" AND profile.Custom\_String eq "Custom Value" | Users that are ACTIVE and have a custom attribute Custom\_String equal to "Custom Value" | | Account Aggregation Filters | status eq "ACTIVE" OR profile.Custom\_String eq "Custom Value" | Users that are either ACTIVE or have a custom attribute Custom\_String equal to "Custom Value" | | Account Aggregation Filters | (status eq "LOCKED\_OUT" OR status eq "DEPROVISIONED") AND lastUpdated gt "2025-01-01T11:18:30.000Z" | Users with any of the specified statuses and last updated after a specific timestamp | | Group Aggregation Filters | type eq "APP\_GROUP" AND (lastUpdated lt "2024-01-01T00:00:00.000Z" OR id eq "00gjmzgoxnydWGs740h7") | Groups filtered by type and either last updated before a specific date or matching a specific group id | # Supported Features The Okta connector supports the following features: > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. For more information on opening a support ticket, refer to [Working With Services](). - Load accounts - \*Provision accounts - Unlock accounts - \*Access Certifications (certification of entitlements connected to accounts) - Delta Aggregation - \*Password management - Enable and disable accounts - Delete accounts - Pass-through authentication For more information on features, refer to [Source Features](). ## The `factors` Attribute The Okta source supports the multi-valued `factors` attribute related to the `Multi-Factors` attribute in the Okta managed system. The Okta source can aggregate and provision the `factors` attribute. Provisioning this attribute maps to the Enroll Multi-Factors operation in the Okta managed system. > [!NOTE] > > To aggregate the Multi-Factors data associated with an aggregated user, you must add the `factors` attribute to the account schema of the source and execute full aggregation one time. For more information on adding account schema attributes, refer to [Adding Attributes to a Source Schema](). `factors` data is aggregated as shown in the following example: - Attribute Name - `factors` - Attribute Value - `factorType=sms ; provider=OKTA , factorType=push ; provider=OKTA, factorType=token:software:totp ; provider=OKTA` > [!NOTE] > > Adding the `factors` attribute will increase the aggregation execution time. ## Multiple Group Objects The Okta source supports the multiple group objects. Following are the details of features: | Features | Users | | --- | --- | | Create | ✔ | | Aggregate | ✔ | | Password Management | ✔ | | Group Entitlements (Read, Request, Revoke) | ✔ Groups, Role, Applications - (You need to add the schema object type explicitly) | ## Group Entitlements Group Entitlements are entitlement types for which SailPoint provides ability to aggregate additional details of these entitlement types from the managed system. These objects have separate schema defining list of attributes that aggregation task fetches as additional details when aggregation is run for that Group Entitlement type. | Features | Users | Applications | | --- | --- | --- | | Aggregation | ✔ | ✔ | ## Using Multiple Group Entitlements `groupTargetsHelpDeskAdmin` (aggregates the Group Target for HELP\_DESK\_ADMIN role) By default, for the Okta source supports the `groupTargetsHelpDeskAdmin` attribute is not a part of account schema. To add this attribute to the existing schema, refer to [Adding Attributes to a Source Schema](). The applications attribute is a multi-valued entitlement attribute, and it aggregates the Group Target for HELP\_DESK\_ADMIN role assigned to a user. Use [createSchema API]() to create new group schema for your source. Here is an example for API body content for adding entitlements to the source. ```json { "name": "groupTargetHelpDeskAdmin", "nativeObjectType": "groupTargetHelpDeskAdmin", "identityAttribute": "groupId", "displayAttribute": "name", "hierarchyAttribute": null, "includePermissions": false, "features": [], "configuration": {}, "attributes": [ { "name": "groupId", "type": "STRING", "schema": null, "description": "Unique key for group", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "name", "type": "STRING", "schema": null, "description": "Name of the group", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "created", "type": "STRING", "schema": null, "description": "Timestamp when group was created", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "description", "type": "STRING", "schema": null, "description": "Description of the group", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "lastMembershipUpdated", "type": "STRING", "schema": null, "description": "Timestamp when group's memberships were last updated", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "type", "type": "STRING", "schema": null, "description": "Determines how a group's profile and memberships are managed", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "lastUpdated", "type": "STRING", "schema": null, "description": "Timestamp when group's profile was last updated", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "objectClass", "type": "STRING", "schema": null, "description": "Determines the group's profile", "isMulti": true, "isEntitlement": false, "isGroup": false } ] } ``` ## Additional Configurations ### Applications If the `applications` schema is configured, use the following parameters to fine tune the application's aggregation. - **Filter Conditions for Applications** - This is an optional condition to bring a subset of Applications during aggregation. For example, `status eq "ACTIVE"`. Refer to the [Update Source (Partial)]() for more information. ```http PATCH https://{orgName}.api.identitynow.com/v3/sources/{OktaSourceID} [ { "op": "add", "path": "/connectorAttributes/applicationAggFilter", "value": "status eq \"INACTIVE\"" } ] ``` - **Application Page Size** - Sets the maximum size of each dataset when querying a large number of applications by adding the entry key as follows: ```http PATCH https://{orgName}.api.identitynow.com/v3/sources/{OktaSourceID} [ { "op": "add", "path": "/connectorAttributes/appsPageSize", "value": 200 } ] ``` The default value is `200`. For more information, refer to [Update Source (Partial)](). - **Disable Application Caching** - To skip creation of application cache, set `noAppCaching` to `true`. ```http PATCH https://{orgName}.api.identitynow.com/v3/sources/{OktaSourceID} [ { "op": "add", "path": "/connectorAttributes/noAppCaching", "value": true } ] ``` For more information, refer to [Update Source (Partial)](). - **Enable Application Skinny User** - (Applicable only for caching the approach of account partitioning aggregation) - Enables the `skinny_user` endpoint to bring applications connected to user in Okta connector by adding the entry key as follows: ```http PATCH https://{orgName}.api.identitynow.com/v3/sources/{OktaSourceID} [ { "op": "add", "path": "/connectorAttributes/applicationSkinnyUsers", "value": true } ] ``` For more information, refer to [Update Source (Partial)](). > [!CAUTION] > > Adding the `applications` attribute and the corresponding `application` schema will increase the execution time for the aggregation operation. ### `groupTargetsHelpDeskAdmin` If the `groupTargetsHelpDeskAdmin` schema is configured, use the following parameters to fine tune the application's aggregation. - Filter conditions for `groupTargetsHelpDeskAdmin` - This is an optional condition to bring a subset of `groupTargetsHelpDeskAdmin` during aggregation. For example, `type eq "BUILT_IN"`. For more information, refer to the [Update Source (Partial)](). ```http PATCH https://{orgName}.api.identitynow.com/v3/sources/{OktaSourceID} [ { "op": "add", "path": "/connectorAttributes/groupTargetAggFilter", "value": "type eq \"BUILT_IN\" OR \"OKTA_GROUP\" " } ] ``` ## Support for APP Target and APP Instance Target for APP\_ADMIN Role ### APP Target Aggregation > [!CAUTION] > > Enabling this feature will have a performance impact. By default, for the Okta source the `applicationsManagedByRole` attribute is not a part of the account schema. To add this attribute to the existing schema, refer to [Adding Attributes to a Source Schema](). The `applicationsManagedByRole` attribute is a multi-valued entitlement attribute, and it aggregates the APP Target and APP Target Instance for `APP_ADMIN` assigned to a user separated by the delimiter, `###`. ### APP Target Provisioning Supports add/remove of `applicationsManagedByRole` attribute. > [!NOTE] > > If `APP_ADMIN` role is not already assigned to the user then while assigning the APP Target and APP Instance Target, the APP\_ADMIN role is assigned to user automatically. ## Support for Group Target for HELP\_DESK\_ADMIN Role ### Group Target Aggregation > [!CAUTION] > > Enabling this feature will have a performance impact. By default, for the Okta source the `groupTargetsHelpDeskAdminRole` attribute is not a part of the account schema. To add this attribute to the existing schema, refer to [Adding Attributes to a Source Schema](). The `groupTargetsHelpDeskAdminRole` attribute is a multi-valued entitlement attribute, and it aggregates the Group Target for the `HELP_DESK_ADMIN` role assigned to a user. > [!NOTE] > > If you select string for the attribute type, then only the `groupId` of the Group Target for the `HELP_DESK_ADMIN` role assigned to a user is populated. ### Group Target Provisioning You can add or remove `groupTargetsHelpDeskAdminRole` attribute via provisioning. > [!NOTE] > > If the `HELP_DESK_ADMIN` role is not already assigned to a user, then it is automatically assigned while assigning the `groupTargetsHelpDeskAdminRole`. ## Support for Aggregation of Custom Roles The Okta source supports aggregation of custom roles directly associated with both accounts and groups in the following format: `RoleName#ResourceSetName` In order to leverage this functionality, you need to add these attributes into the account and group schemas: - **Attribute Name** - `customRoles` - **Property Type** - string - Select the **Entitlement**, **Multivalued** checkboxes. The Okta source also supports the addition and removal of Custom Roles from the user. ## Support for Custom Attributes The Okta connector supports the aggregation and provisioning of custom attributes belonging to User Profile. In order to leverage this functionality, user needs to add these attributes into the account: - **Attribute Name** - `customAttribute` - **Type** - string > [!NOTE] > > Custom attributes can have multiple values. Custom Attribute is also supported for account aggregation. ## Support for the Standard Roles Associated with Group The Okta source supports the aggregation of Standard roles associated with Groups. In order to leverage this functionality, you need to add these attributes into the group schema: - **Attribute Name** - `roles` - **Property Type** - string - Select the **Entitlement**, **Multivalued** checkboxes. ## Enabling and Disabling Accounts Enabling a User Account also activates a user in Okta. Disabling a User Account will either suspend or deprovision a user in Okta depending on your provisioning configuration. For more information on configuration, refer to [Provisioning Settings](). Account Update is supported for the suspended/deprovisioned account while performing the Enable operation. ## Non-Human Identity Discovery The Okta SaaS connector aggregates the following non-human identities: - Okta OpenID Connect (OIDC) applications and their governance credentials, including client secrets and public keys. For more information on aggregating applications, refer to [Machine Identity Governance Settings](). - Okta organization-level Admin API tokens, correlated to the human identity that created each token. > [!IMPORTANT] > > The connector stores credential metadata only. It does not aggregate client secret values or API token values. For datasets, resources, and aggregation settings, refer to [Dataset Management](). Refer to [Discovering Potential Non-Human Accounts]() for more information. ## Activity Insights Activity Insights supports activity from Okta and its associated accounts. This allows you to gather account information and activity data from Okta. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on configuring Activity Insights, refer to Activity Insights Settings. Ensure the Okta source has necessary scopes to utilize the Activity Insights. Refer to [Required Permissions]() for the requested scopes for Activity Insights from Okta. ## Privilege Classification SailPoint Privilege Classification helps organizations systematically categorize and manage the privilege levels of entitlements within their sources. By classifying entitlements as high, medium, or low, administrators can better understand the potential risk and impact associated with specific access rights. This allows automatic assignment of privilege levels based on system recommendations, custom-defined criteria, or a same level across all entitlements. | Privilege Level | Description | | --- | --- | | High | Administrative level access to accounts | | Medium | Administrative level access for a specific role or function | | Low | Only basic access of data | > [!NOTE] > > To manage Privilege Classification, users must have administrative roles such as Org Admin, Source Admin or Source Sub-Admin. For more information, refer to [Managing Privilege Classification](). # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Issues in Delta Aggregation The following are various scenarios where data is not populated in Delta Aggregation: - Roles assigned to an account from API are not populated in delta aggregation. Sometimes applications that are removed from users are not aggregated in account delta aggregation. **Resolution** - Perform full account aggregation task. - Sometimes groups that are deleted from the managed system are not captured in account delta aggregation. **Resolution** - Perform full group aggregation to refresh entitlements. - For an account created with only the default group **Everyone** event system logs are not captured. **Resolution** - To see the default group assigned to account, perform a full account aggregation or create account with a different group so that in delta aggregation for account, both groups details (default and the other group) are aggregated. - If the HELP\_DESK\_ADMIN role is removed from a user on the managed system, sometimes after delta aggregation `groupTargetHelpDeskAdminRole` is not removed. - If `groupTarget` is removed from user HELP\_DESK\_ADMIN role, sometimes changes are not reflected after delta aggregation **Resolution** - Perform full account aggregation task. - If APP\_ADMIN role is removed from a user on the managed system, sometimes after delta aggregation `applicationsManagedByRole` is not removed. - If `applicationsManagedByRole` is removed from user APP\_ADMIN role, sometimes changes are not reflected after delta aggregation. **Resolution** - Perform full account aggregation task. ## Delta aggregation processes account deletes regardless of Detect Deleted Delta aggregation processes account deletes even when **Detect Deleted** is not enabled. **Resolution** - As a workaround, add the following entry to the source XML using the REST APIs: ```json [ { "op": "add", "path": "/connectorAttributes/accountFilterAttribute", "value": "true" } ] ``` > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ## Unlocked Okta Account Displays Incorrect Status For Unlocked Okta accounts, the account details might not display the correct status. This occurs when the managed account refresh action only affects the status of the account in SailPoint. Account details are not changed and `status` is one of the account attributes. **Resolution** - To get the correct account details and value of the **Account status**, then execute the account aggregation task. ## Create Account Fails for an Account Assigned to the 'Everyone' Group By default, on the Okta managed system the group **Everyone** gets assigned to every account created. Create account fails with following error message displayed: ```text sailpoint.connector.ConnectorException: [ConnectorException] [Error details] Request execution failed. HTTP Error code: 501, Okta Error code: E0000060, errorSummary: Unsupported operation., errorCauses:[]. ``` **Resolution** - While performing create account in **Access Profiles**, select a group type other than **Everyone**. ## While performing Account Aggregation warnings are displayed in the logs While performing account aggregation the following warnings are displayed in the logs: ```text 019-04-18 18:43:25,708 WARN Thread-743 openconnector.connector.okta.OktaConnector:5425 - API rate limit exceeded for endpoint, Retrying the failed request now 2019-04-18 18:43:25,709 WARN Thread-742 openconnector.connector.okta.OktaConnector:5425 - API rate limit exceeded for endpoint, Retrying the failed request now ``` **Resolution** - You may ignore the warning messages. But to improve Okta aggregation performance, increase the Okta API rate limit. ## While creating or updating primary email address of Okta user, it updates Username (login) as same email address While creating or updating the primary email address of Okta user, it updates their Username (login) as the same email address. Okta has a feature of self-service registration policy. When `SELF_SERVICE_REGISTRATION` is enabled on Okta managed system, Okta enforces uniqueness for all primary email addresses and automatically uses that email address as the end user's username (login) and primary email address. **Resolution** - Disable `SELF_SERVICE_REGISTRATION` in Okta managed system. For more information contact Okta Customer Support. ## Account Aggregation fails with an error message - The following error message displays: ```text Exception during aggregation of Object Type account on Application Okta. Reason: [ InvalidConfigurationException ] [ Possible suggestions ] Ensure the resource mentioned in the Okta URL is correct. The URL resource is /api/v1/groups//users?limit=10000 [ Error details ] Request execution failed. HTTP Error code : 405, Okta Error code : E0000022, errorSummary : The endpoint does not support the provided HTTP method, errorCauses:[] ``` **Resolution** - Due to the HTTP 405 response code from Okta instance, ensure that the Okta URL is correct and able to access the Okta resources. This issue occurs due to the vanity Okta URL (customized). Verify the correct settings with Okta team and allow the API response. - While performing account aggregation with the **OAuth 2.0** authentication type, aggregation fails with the following error message: ```text openconnector.ConnectorException: [ ConnectorException ] [ Error details ] Request execution failed. HTTP Error code : 403, Okta Error code : E0000005, errorSummary : Invalid session, errorCauses:[]. ``` **Resolution** - If the `type_name` and `type_displayName` attributes are configured in the account schema, delete these attributes and perform the account aggregation. > **Note** > > Aggregation of `type_name` and `type_displayName` is only supported with the **API Token** authentication type. - The following error message displays: ```text Exception during aggregation of Object Type account on Application Okta. Reason: Unable to create iterator sailpoint.connector.InsufficientPermissionException: [InsufficientPermissionException] [Possible suggestions] Furnish appropriate permission to the Okta API token owner. [Error details] Insufficient privileges detected. HTTP Error code: 401, Okta Error code: E0000015, errorSummary: You do not have permission to access the feature you are requesting ``` **Resolution**: - Ensure that the correct permissions or roles are assigned to the API Owner (the user whose API token is used in the Okta application). The API Owner must have SUPER ADMIN roles assigned for aggregation. > **Note** > > To aggregate Okta roles, SUPER\_ADMIN role is required. - The **List Users with Search** parameter supports pagination (to a maximum of 50000 results). - Ensure you correctly set the **List Users with Search** attribute. ## Test Connection failures with OAuth 2.0 authentication While performing a test connection, it fails with following errors: - The following error message displays: ```text [ InvalidRequestException ] [ Error details ] Request execution failed. HTTP Error code : 400, Okta Error code : invalid_client, errorSummary : Invalid value for 'client_id' parameter., errorCauses:[]. ``` **Resolution** - Ensure that the **Client ID** is correct and it is the same as the **Client ID** of the service application created in Okta. - The following error message displays: ```text [ ConnectorException ] [ Error details ] Request execution failed. HTTP Error code : 401, Okta Error code : invalid_client, errorSummary : The subject claim for client_assertion is not a valid client_id., errorCauses:[]. ``` **Resolution** - Ensure that the **Client ID** is correct and it is the same as the **Client ID** of the service application created in Okta. - The following error message displays: ```text [ ConnectorException ] [ Error details ] Request execution failed. HTTP Error code : 401, Okta Error code : invalid_client, errorSummary : The audience claim for client_assertion must be the endpoint invoked for the request., errorCauses:[]. ``` **Resolution** - Ensure that the URL provided in **OAuth 2.0 Token URL** is correct for authorization. - The following error message displays: ```text [ ConnectorException ] [ Error details ] Request execution failed. HTTP Error code : 401, Okta Error code : invalid_client, errorSummary : The client_assertion JWT kid is invalid., errorCauses:[]. ``` **Resolution** - If multiple keys are present in the Okta application, add the corresponding KID to the **JWT Header** field: ```json { "typ": "JWT", "alg": "RS256", "kid": "" } ``` - The following error message displays: ```text [ InvalidConfigurationException ] Failed to decrypt the private key. class org.bouncycastle.asn1.pkcs.PrivateKeyInfo cannot be cast to class org.bouncycastle.openssl.PEMKeyPair ``` **Resolution** - The private key must be in PKCS\#1 format. Confirm that the first line of the private key is `-----BEGIN RSA PRIVATE KEY-----`. A key that begins with `-----BEGIN PRIVATE KEY-----` is PKCS\#8 and is not supported. For generation and conversion commands, refer to [Authenticate with OAuth 2.0](). ## Operations failed with an error message While performing any operation with OAuth 2.0 Authentication Type, it fails with the following error message: ```text [ ConnectorException ] [ Error details ] Request execution failed. HTTP Error code : 403, Okta Error code : , errorSummary : , errorCauses:[]. ``` **Resolution** - Ensure that the appropriate scopes are provided to the Okta service application and the same are provided in the `scope` configuration parameter. ## Error while removing APP Target, App Instance Target, or Group Target from a User ```text [ InvalidConfigurationException ] [ Possible suggestions ] Ensure the resource mentioned in the Okta URL is correct. The URL resource is //api/v1/users/00u1jw6jffvr3GG395d7/roles/IFIFAX2BIRGUSTQ/targets/catalog/apps/hellofax [ Error details ] Request execution failed. HTTP Error code : 405, Okta Error code : E0000091, errorSummary : The provided role type was not the same as required role type., errorCauses:[]. [ InvalidConfigurationException ] [ Possible suggestions ] Ensure the resource mentioned in the Okta URL is correct. The URL resource is //api/v1/users/00u2on1gcpgu4gIc55d7/roles/JBCUYUC7IRCVGS27IFCE2SKO/targets/groups/00g2dyy3zoPvqGkvI5d7 [ Error details ] Request execution failed. HTTP Error code : 405, Okta Error code : E0000091, errorSummary : The provided role type was not the same as required role type., errorCauses:[]. ``` **Resolution** - Do not remove last app target or app instance target. Instead, directly remove the `APP_ADMIN` role or the `HELP_DESK_ADMIN` role from the user. ## Add Entitlement Failed is populated in the activity log while creating or updating APP Target, App Instance Target, or Group Target to User **Resolution** - Ensure the following: - While assigning APP target and App Instance Target to the user, APP\_ADMIN role is not in the request. - While assigning Group Target to the user, HELP\_DESK\_ADMIN role is not in the request. ## The Update Account attribute failed during the Enable operation The following error message is displayed while modifying the account attribute during the Enable operation: ```text Request execution failed. HTTP Error code : 409, Okta Error code : E0000112, errorSummary : Cannot update this user because they are still being activated. Please try again in a few minutes., errorCauses:[]. ``` **Resolution** - Add the following entry to the source XML using the REST APIs: ```text Patch https://{orgName}.api.identitynow.com/v2025/sources/{OktasourceID} ``` In the body of the Patch, use the form-data as follows: ```json { "op": "add", "path": "/connectorAttributes/connector_provisioningTimeout", "value": "20000" } ``` > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ## User status is not being updated after the Enable or Disable operation Due to slow Okta API response times, there may be a delay in receiving the correct user status after performing the Enable or Disable operation. **Resolution** - Add the following entry to the source XML using the REST APIs: ```text Patch https://{orgName}.api.identitynow.com/v2025/sources/{OktasourceID} ``` In the body of the Patch, use the form-data as follows: ```json { "op": "add", "path": "/connectorAttributes/connector_provisioningTimeout", "value": "20000" } ``` > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. ## Test connection failing with error message When performing a test connection, it fails and the following error displays: ```text Exception: sailpoint.connector.ConnectionFailedException: [ ConnectionFailedException ] [ Possible suggestions ] a) Make sure Okta instance is reachable. b) Make sure there is a smooth connectivity between Identity Server and Okta instance. [ Error details ] Failed to connect to the Okta instance. ``` If there is a firewall between SailPoint and the Okta tenant, it is likely causing the blocking the connection. **Resolution** - Verify if there are any firewall rules present in your environment that are blocking the Okta URL, FQDN, or IP address. If the rules are blocking this communication, unblock them. ## Custom role data for users is not getting aggregated correctly The Okta source supports the aggregation of custom roles that are assigned directly to the accounts only. **Resolution**: Before aggregation, ensure that custom roles for the users and groups are assigned directly. For example, let us assume that for the user John, John Test Role is a custom role. The John Test Role added for the user John is a direct assignment. But, if John Test Role is added to the Custom\_Group, and Custom\_Group is then assigned to the user John. Then, the John Test Role will not be a direct assignment for the user John.