# SailPoint Okta Connector Documentation

> Okta Connector Documentation

# Documentation

# Aggregation Best Practices

Follow below mentioned approach for aggregation in the Okta connector for better performance outcome:

## Approach A: Caching

> [!NOTE]
>
> Caching is recommended for environments having less number of connections(users to groups and/or application).

Aggregation is implemented by creating an application and group cache as explained in the following steps:

1. Okta connector creates cache of user connected to groups.
2. Okta connector creates cache of user connected to applications.
3. Okta connector then fetches the user profiles.
4. Okta connector maps the groups and applications of the fetched user profiles to the caches created during steps 1 and 2 above.

To improve the aggregation performance, use multiple threading for cache creation of groups and applications. Add the following key-value pair in the Source XML using the REST APIs to achieve multiple threading for cache creation:

```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/enableMultiThreadedCacheCreationApps ",
  "value": true
 },
 {
  "op": "add",
  "path": "/connectorAttributes/appCacheThreadSize",
  "value": "2"
 },
 {
  "op": "add",
  "path": "/connectorAttributes/enableMultiThreadedCacheCreationGroups ",
  "value": true
 },
 {
  "op": "add",
  "path": "/connectorAttributes/groupCacheThreadSize",
  "value": "2"
 }
```

> [!NOTE]
>
> Refer to Additional Configuration Parameters for more information.

## Approach B: Sequential

Aggregation is implemented by sequential API call to fetch the user profiles followed by groups and applications with an ability to execute multiple partitions in parallel.

> [!NOTE]
>
> Sequential is recommended for environment having large number of connections (users to groups and/or application).

1. Choose required set of attributes to manage.

   Okta connector supports the management of Roles and Application entitlements assigned to the user. If not required the entitlements can be removed reducing API calls and hence improving the performance.
2. Optimize the configuration parameters and its values.

   Select the following configuration parameters to improve the performance:

   - `ListUsersWithSearch`: By default, the Okta source supports the Okta target managed system's 'List Users with Filter' feature for account aggregation. For Account aggregation with Okta's 'List Users with Search' feature ensure that you enable **List Users With Search**. 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).
   - `groupSkinnyUsers`: Select **Enable Group Skinny User** to enable the skinny\_user endpoint to fetch the groups connected to user in the Okta source. This attribute is only applicable for caching approach of account aggregation.
   - `API Rate Limit`: Enter the maximum API rate limit threshold as the maximum permissible call number.
   - Enable Partitioning to process the data in parallel across multiple threads. Also, set up the Number of Partitioning Thread.

   These configuration parameters can be enabled in your tenant using [Additional Settings](<https://documentation.sailpoint.com/connectors/okta/va/help/connecting.html#additional-settings>).

# Connecting SailPoint and Okta

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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). 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. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section.
6. 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](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
4. Under **Connection Type**, select **Direct Connection** or **Flat File**.

   - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable.
5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source.
6. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
7. 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](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
8. 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. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](<https://documentation.sailpoint.com/saas/help/va/index.html>).
4. (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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
5. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
6. (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](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
7. (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.
8. 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.

### Authenticate with an API Token

Configure your source to authenticate with Okta using an API Token.

> [!NOTE]
>
> **Screenshot**
>
> [![API Token](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_api.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_api.png>)

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](<https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/overview/>).

> [!NOTE]
>
> **Screenshot**
>
> [![OAuth 2.0](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_oa1.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_oa1.png>) [![OAuth 2.0](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_oa2.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_conn_oa2.png>)

> [!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. **Client Credentials** is selected for **Grant Type**. Currently, this is the only grant type supported by this source.
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 |

   For more information on Scopes, refer to [Administrator Permissions](<https://documentation.sailpoint.com/connectors/okta/va/help/index.html#required-permissions>).
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 **Audience** for authorization.
7. Enter the JWT **Issuer** for authorization. This value must be the same as the `client_id`.
8. Enter the JWT **Subject** for authorization. This value must be the same as the `client_id`.
9. 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 into the source configuration.
10. 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.
11. Select **Save**.

### OAuth 2.0 for Pre-existing Sources

For existing Okta sources, the Authentication Type is displayed as an **API Token**. While changing the Authentication Type to OAuth 2.0 for the existing source:

1. Add the `private_key`, `private_key_password`, and `accessToken` attributes to the encrypted tag with the connector-encrypted key, using the REST API. For more information, refer to [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1>).
2. Remove the `type_name` and `type_displayName` attributes from account schema if they are present.

> [!NOTE]
>
> Aggregation of the `type_name` and `type_displayName` is not supported in Okta managed system for OAuth 2.0 authentication type. It is recommended to use API token authentication for aggregating these attributes.

## Aggregation Settings

Configure how your source handles aggregation.

For more information about aggregation, refer to [Loading Account Data](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>).

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg1.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg1.png>) [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg2.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg2.png>) [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg3.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg3.png>)

### Filter Settings

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](<https://documentation.sailpoint.com/connectors/okta/va/help/supported_agg_filters.html>).

### Delta Aggregation

Enable **Delta Aggregation** for account aggregation.

For more information, refer to [Configuring Delta Aggregations for Supported Sources](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-delta-aggregations-for-supported-sources>).

Log data older than 90 days is not returned in accordance with Okta's Data Retention Policy. This means that any data changes done prior to 90 days since the last successful account aggregation isn't be captured and a full account aggregation will be required.

The Okta source uses the Log API instead of the Event API for delta aggregation. There is a replacement of the Event API entry with the Log API in the source XML file.

### Page Size Settings

1. Set the **User Page Size**. This is the maximum size of each dataset when querying large number of objects. The minimum value is 1 and maximum value is 200. Default: 200.
2. Enter the **Group Page Size** value. This is the maximum size of each dataset while querying a large number of Groups. The default value is 10000, you set and change as per your requirement.
3. Enter the **Logs Page Size** value. This is the maximum size of each dataset while querying large number of Logs. The default value is 1000, you set and change as per your requirement.

> [!NOTE]
>
> The group filter will apply for both account and entitlement aggregation.

### Additional Settings

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Settings](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg4.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg4.png>)

1. Enter an **API Rate Limit** for the maximum API rate limit threshold as the maximum permissible call number. For pre-existing sources, 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. Enter an **Aggregation Time Out** value. This is the duration of time in seconds after which an aggregation operation times out. By default, it is 900 seconds.
3. 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 **Disable Group Caching** field.
4. 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.
5. 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](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg5.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_agg5.png>)

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.

   If the VA is configured for multiple CPU cores, it can be configured for a higher number of partition threads to improve performance even further.
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](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_prov_set.png>)](<https://documentation.sailpoint.com/connectors/okta/va/help/img/okta_prov_set.png>)

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**.

## 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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with Okta

> [!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](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

Refer to [Supported Features](<https://documentation.sailpoint.com/connectors/okta/va/help/supported_features.html>) for more information.

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).
- To ensure proper functionality of the Okta Source, a minimum CCG version of 1041 is required.
- 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://developer.okta.com/docs/api/getting_started/getting_a_token.html>) 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](<https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/overview/>) 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](<https://documentation.sailpoint.com/connectors/okta/va/help/connecting.html#authenticate-with-oauth-20>) 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 |

### OAuth 2.0 Authentication

> [!NOTE]
>
> The service application created in Okta must have the "Admin Roles" defined as outlined in the "API Token Authentication" section above along with scopes defined in below table.

| Operation | Scopes |
| --- | --- |
| Mandatory Scopes | okta.logs.read okta.users.manage okta.groups.manage |
| Additional Scopes to Manage the 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 |

### Minimum Permissions

| Auth Method | What Needs the Role | Minimum Role | Minimum Scopes (Read-Only Discovery) |
| --- | --- | --- | --- |
| API Token | The Okta user whose token is used | Read-Only Administrator (sufficient for discovery), Organization Administrator OR Super Administrator | n/a (token inherits the user's permissions) |
| OAuth 2.0 | The API Services App | Read-Only Administrator (sufficient for discovery), Organization Administrator OR Super Administrator | okta.users.read okta.apps.read |

# Machine Account Attributes

Machine account attributes are used in provisioning configurations for machine accounts.

After you have [created the required machine account subtypes](<https://documentation.sailpoint.com/saas/help/machine/account_configuration.html#creating-machine-account-subtypes>), you can use the machine account attributes to provision machine accounts in your SailPoint tenant.

Refer to [Machine Identity Security Overview](<https://documentation.sailpoint.com/saas/help/machine/index.html>) 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 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://documentation.sailpoint.com/saas/help/provisioning/create_profile.html#creating-attributes>).

### 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](<https://community.sailpoint.com/knowledge/collection/working-with-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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) 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 connector uses the following default correlation and object configurations.

## Identity Profile Mapping

The Okta 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) 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 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](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) 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 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-schema>). Use the [createSchema](<https://developer.sailpoint.com/docs/api/create-source-schema-v-1/>) 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. |

# Migrate VA-based Source to a SaaS Source

Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection.

To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source.

> [!NOTE]
>
> - You must have an Admin or Source Admin user level to migrate a source.

A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is.

For more information on the Okta SaaS connector, refer to the [Okta SaaS Supported Features](<https://documentation.sailpoint.com/okta/saas/help/index.html#supported-features>).

## Important Considerations Before Migrating

- You do not need to edit additional configurations (other than connection credentials) to migrate the source.
- If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version.
- Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source.
- Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration.

## Migrating Sources

To migrate your source, complete the following:

1. Go to **Admin \> Connections \> Sources**.
2. Select or edit the VA-based source you want to migrate.
3. Open the source configuration, and select **Migrate to SaaS**.
4. When prompted, select **Continue**.

   A draft version of the source is created. The live source will continue to work.
5. Select **Connection Settings**.
6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection.

   > **Important**
   >
   > Avoid editing the other configuration options in the draft source.
7. Select **Review and Test**.
8. Select **Test Connection**.
9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities.
10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings.
11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**.

    Your changes will be applied to the live source and the draft source will be deleted.

## Viewing Source Migration Status

You can view the status and creation date of draft sources.

1. Go to **Admin \> Connections \> Sources \> Source Migration Status**.
2. Select **Source Migration Status**.
3. To view or edit the draft source, select **Actions** ![](<https://documentation.sailpoint.com/connectors/okta/va/help/common/assets/img/actions_menu.png>) **\> Preview** on the draft source.
4. To delete the draft source, select **Actions** ![](<https://documentation.sailpoint.com/connectors/okta/va/help/common/assets/img/actions_menu.png>) **\> Delete** on the draft source.

# 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](<mailto:login@example.com>)" | Users with a specified login |
| profile.email eq "[email@example.com](<mailto: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](<https://documentation.sailpoint.com/connectors/okta/va/help/supported_features.html#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](<https://community.sailpoint.com/knowledge/collection/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](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://developer.sailpoint.com/docs/api/create-source-schema-v-1/>) 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)](<https://developer.sailpoint.com/docs/api/update-source-v-1>) 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)](<https://developer.sailpoint.com/docs/api/update-source-v-1>).
- **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)](<https://developer.sailpoint.com/docs/api/update-source-v-1>).
- **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)](<https://developer.sailpoint.com/docs/api/update-source-v-1>).

> [!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)](<https://developer.sailpoint.com/docs/api/update-source-v-1>).

  ```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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-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](<https://documentation.sailpoint.com/connectors/okta/va/help/connecting.html#provisioning-settings>).

Account Update is supported for the suspended/deprovisioned account while performing the Enable operation.

## 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](<https://documentation.sailpoint.com/saas/help/loading_entitlements/privilege_classification.html>).

## Password Management

If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following:

- The password policy defined in SailPoint applies to accounts on this source.
- If you change the password for an application connected to this source, the change will automatically be made to the source itself.

For more information on configuring password management, refer to [Password Management Overview](<https://documentation.sailpoint.com/saas/help/pwd/index.html>).

# Enable Connector Logging

This topic provides the steps needed to enable logging on SailPoint using REST APIs.

> [!NOTE]
>
> This topic only applies to VA-based integrations.

> [!NOTE]
>
> The examples provided might not match your configuration. Use the logging levels and logging classes reference at the bottom of the topic to configure your API responses to match your connector.

This process is broken up into four steps:

1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging.
2. Get the logging configuration for the existing VA cluster.
3. Update the VA cluster to enable logging levels.
4. Observe logging changes to the logging levels.

### Identify the Virtual Appliance Cluster

Select the VA on which you need to enable logging using REST API. If you already know the VA application's `id`, proceed to [Get the Logging Configuration](<#get-the-logging-configuration>).

1. Make the following call to the REST API to return a list of available VA clusters:

   GET /v3/managed-clusters

   The REST API returns a response that looks similar to the following:

   ```json
   [
       {
           "id": "2c9180866166b5b0016167c32ef31a66",
           "name": "Development Cluster",
           "description": "Development Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": null
       },
       {
           "id": "2c9180846a93ce60016ab29f039944de",
           "name": "Cloud Cluster",
           "description": "Cloud Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": {
               "clientId": null,
               "durationMinutes": 60,
               "expiration": "2020-12-15T19:13:36.079Z",
               "rootLevel": "DEBUG",
               "logLevels": {
                   "sailpoint.connector.ADLDAPConnector": "DEBUG"
               }
           }
       }
   ]
   ```

   > **Note**
   >
   > The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the `logConfiguration` value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster.
2. Identify the VA cluster that you want to enable logging on by its name or description and record its `id` attribute.

### Get the Logging Configuration

Get your selected VA's cluster logging configuration and identify the values you need to update.

1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   GET /v3/managed-clusters/{id}/log-config

   - If the VA doesn't have a logging configuration currently set, it returns `204 No Content` as a response.
   - If the VA has an existing logging configuration, it returns something similar to the following:

     ```json
     {
         "clientId": null,
         "durationMinutes": 60,
         "expiration": "2020-12-15T19:13:36.079Z",
         "rootLevel": "DEBUG",
         "logLevels": {
             "sailpoint.connector.ADLDAPConnector": "DEBUG"
         }
     }
     ```

     You'll need to configure the following information in the response:

     - `durationMinutes` is the number of minutes logging should remain enabled.
     - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
     - `logLevels` is a map object with logging classes as keys and logging levels as values.

       - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
       - For a list of available values, refer to [Logging Levels](<#logging-levels>).

### Update Logging Configuration

Update the VA cluster configuration returned by the REST API to update the logging settings as needed.

1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace `{id}` with the VA cluster's `id` attribute value recorded earlier.

   PUT /v3/managed-clusters/{id}/log-config
2. Submit your configuration changes to the REST API in a JSON body.

   - If the VA cluster did not already have a logging configuration and you received a `204 No Content` response, you can create a new one.
   - If the VA returned a configuration, you can edit it to include the changes.

   The JSON body should be as follows:

   ```json
   {
       "durationMinutes": 60,
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

   Consider the following as you edit the JSON:

   - `durationMinutes` is the number of minutes logging should remain enabled.
   - `rootLevel` is the default level for all logs. For more information, refer to [Logging Levels](<#logging-levels>).
   - `logLevels` is a map object with logging classes as keys and logging levels as values.

     - For keys, refer to [Logging Classes](<#logging-classes>) for commonly used logging classes.
     - For a list of available values, refer to [Logging Levels](<#logging-levels>).

   If the update was successful, the REST API should return a response similar to the following:

   ```json
   {
       "clientId": null,
       "durationMinutes": 60,
       "expiration": "2020-12-15T19:13:36.079Z",
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   ```

### Observe Logging Changes

Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in **ccg.log**.

### References

The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file.

#### Logging Levels

| Logging Level | Description |
| --- | --- |
| ERROR | Designates error events that might still allow the connector to continue. |
| WARN | Designates potentially harmful situations. |
| INFO | Designates information messages that highlight process at a coarse-grain level. |
| DEBUG | Very verbose. Fine grain logging levels used for development and debugging. |
| TRACE | Most verbose. Finer grain logging levels than debugging. |

#### Logging Classes

| Connector | Logging Class |
| --- | --- |
| Active Directory | sailpoint.connector.ADLDAPConnector sailpoint.connector.LDAPConnector |
| AIX | openconnector.connector.unix.AIXConnector openconnector.connector.unix.UnixConnector |
| Amazon Web Services | logger.aws.name=openconnector.connector.aws logger.aws.level=trace logger.aws.additivity = false logger.aws.appenderRef.rolling.ref = STDOUT |
| Atlassian Suite Cloud | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianConnector |
| Atlassian Data Center | sailpoint.connector.OpenConnectorAdapter openconnector.connector.atlassian.AtlassianDataCenterConnector |
| Microsoft Entra ID | sailpoint.connector.AzureADConnector |
| Box | openconnector.connector.BoxNetConnector sailpoint.connector.OpenConnectorAdapter |
| Cerner | openconnector.connector.CernerConnector sailpoint.connector.OpenConnectorAdapter |
| Delimited File | logger.DelimitedFileConnector.name = sailpoint.connector.DelimitedFileConnector logger.DelimitedFileConnector.level = debug logger.DelimitedFileConnector.additivity = false logger.DelimitedFileConnector.appenderRef.rolling.ref = STDOUT |
| Dropbox | openconnector.connector.DropBoxConnector sailpoint.connector.OpenConnectorAdapter |
| Epic | openconnector.connector.EPICConnector sailpoint.connector.OpenConnectorAdapter |
| GE Centricity | openconnector.connector.GECentricity sailpoint.connector.OpenConnectorAdapter |
| Google Apps / G Suite | openconnector.connector.GoogleAppsDirect sailpoint.connector.OpenConnectorAdapter |
| IBM i | openconnector.connector.IBMiConnector |
| Lotus Domino | sailpoint.connector.LotusDomino |
| JDBC | sailpoint.connector.JDBCConnector |
| Sun One LDAP | sailpoint.connector.LDAPConnector |
| Linux | openconnector.connector.unix.LinuxConnector sailpoint.connector.OpenConnectorAdapter sailpoint.connector.UnixConnector |
| Microsoft Office365 | sailpoint.connector.Office365Connector |
| Microsoft SQL Server | sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2 |
| Okta | logger.openconnector.name = openconnector.connector.okta.OktaConnector logger.openconnector.level = debug logger.openconnector.additivity = false logger.openconnector.appenderRef.rolling.ref = STDOUT |
| Oracle Database | sailpoint.connector.OracleDBConnector sailpoint.connector.JDBCConnector |
| Oracle E-Business | sailpoint.connector.OracleEBSConnector sailpoint.connector.JDBCConnector |
| Oracle Fusion HCM | openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector sailpoint.connector.OpenConnectorAdapter |
| Oracle HCM Cloud | sailpoint.connector.oraclehcmcloud.OracleHCMCloudConnector |
| Oracle HRMS | sailpoint.connector.OracleAppsHRMSConnector sailpoint.connector.JDBCConnector |
| Oracle Netsuite | openconnector.connector.netsuite.NetsuiteConnector |
| PeopleSoft ERP | openconnector.connector.PeopleSoftConnector sailpoint.connector.OpenConnectorAdapter |
| PeopleSoft HRMS | sailpoint.connector.PeopleSoftHRMSConnector |
| RemedyForce | sailpoint.connector.ForceConnector |
| RSA Authentication Manager | openconnector.connector.RSAConnector openconnector.connector.rsa.RSAHTTPClient sailpoint.connector.OpenConnectorAdapter |
| Salesforce | sailpoint.connector.ForceConnector |
| SAP Concur | openconnector.connector.sapconcur.SAPConcurConnector |
| SAP - Direct | sailpoint.connector.SAPConnector sailpoint.connector.SAPInternalConnector |
| SAP GRC | logger.SAPGRCConnector.name = sailpoint.connector.sapgrc logger.SAPGRCConnector.level = debug logger.SAPGRCConnector.additivity = false logger.SAPGRCConnector.appenderRef.rolling.ref = STDOUT |
| SAP HR/HCM | sailpoint.connector.SAPHRInternalConnector |
| SCIM 1.1 | openconnector.connector.SCIMConnector sailpoint.connector.OpenConnectorAdapter |
| SCIM 2.0 | openconnector.connector.scim2.SCIM2Connector sailpoint.connector.OpenConnectorAdapter |
| ServiceNow | openconnector.connector.servicenow.ServiceNowConnector openconnector.connector.servicenow.ServiceNowRestClient sailpoint.connector.OpenConnectorAdapter |
| ServiceNow Service Desk Integration | openconnector.connector.servicedesk.ServiceNowServiceDeskConnector sailpoint.connector.OpenConnectorAdapter |
| Siebel | openconnector.connector.SiebelConnector sailpoint.connector.OpenConnectorAdapter |
| Snowflake | openconnector.connector.snowflake.SnowflakeConnector sailpoint.connector.OpenConnectorAdapter |
| Solaris | openconnector.connector.unix.SolarisConnector openconnector.connector.unix.UnixConnector sailpoint.connector.OpenConnectorAdapter |
| SuccessFactors | sailpoint.connector.SuccessFactorsConnector |
| Sybase | sailpoint.connector.SybaseDirectConnector sailpoint.connector.JDBCConnector |
| Webex | openconnector.connector.Webex sailpoint.connector.OpenConnectorAdapter |
| Workday | openconnector.connector.WorkDay sailpoint.connector.OpenConnectorAdapter |
| Workday Accounts | openconnector.connector.workdayaccounts openconnector.connector.workdayaccounts.WorkdayAccountsConnector sailpoint.connector.OpenConnectorAdapter |
| Web Services | sailpoint.connector.WebServices |
| XML | openconnector.connector.XMLConnector sailpoint.connector.OpenConnectorAdapter |
| Yammer | openconnector.connector.YammerConnector sailpoint.connector.OpenConnectorAdapter |
| Zoom | openconnector.connector.zoom.ZoomConnector sailpoint.connector.OpenConnectorAdapter |

# 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](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

> [!IMPORTANT]
>
> Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided.

## Provisioning Retry Errors

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

SailPoint connectors that support provisioning operations have the ability to retry a failed operation based on configurable error messages.

The `retryableErrors` entry in the connector configuration is a list of strings that the connector searches for in the error message received from the managed source. If any of the configured error strings are found in the error message, the connector will attempt to retry the provisioning operation.

Add a list of retryable error messages to the attributes map of the source configuration. The value must be specified as a list or array even when only a single error string is provided. If the error message contains one of the specified strings, the connector will initiate a retry attempt. However, if the configured error string is not present in the error message, the connector will consider the operation as failed and will not attempt a retry.

Add the following entry in the source XML using the SailPoint REST APIs:

For example,

Use the SailPoint API by sending a PATCH request to the /v3/sources/{id} endpoint:

`PATCH https://{orgName}.api.identitynow.com/v3/sources/:id`

In the body of the PATCH, enter the retryable errors as follows:

```json
[
    {
        "op": "add",
        "path": "/connectorAttributes/retryableErrors",
        "value": [
            "<error_message_1>",
            "<error_message_2>"
        ]
    }
]
```

> [!NOTE]
>
> Error messages containing very specific information about date/time, sequence ID and so on must be avoided. Error codes or error message substrings would be good candidates for inclusion.

## Aggregation Retry Errors

Aggregation retries can be set up for each source by configuring the `aggregationRetryErrors` attribute under the `connectorAttributes` section.

Send a PATCH request to the `/v3/sources/{id}` endpoint:

`PATCH https://{orgName}.api.identitynow.com/v3/sources/:id`

In the body of the PATCH, enter the `aggregationRetryErrors` as follows:

```json
{
    "op": "add",
    "path": "/connectorAttributes/aggregationRetryErrors",
    "value": ["Connection reset"]
}
```

In addition to specifying the aggregation retry errors, you can also configure the following options:

> [!NOTE]
>
> **retryWaitTime**
>
> A string specifying the amount of time (in milliseconds) to wait before attempting a retry. The default value is 5000 milliseconds (5 seconds).
>
> In the body of the PATCH, enter the `retryWaitTime` as follows:
>
> ```json
> {
>     "op": "add",
>     "path": "/connectorAttributes/retryWaitTime",
>     "value": "5000"
> }
> ```

> [!NOTE]
>
> **maxRetryCount**
>
> A string defining the maximum number of retry attempts that will be performed. The default value is 3.
>
> In the body of the PATCH, enter the `maxRetryCount` as follows:
>
> ```json
> {
>     "op": "add",
>     "path": "/connectorAttributes/maxRetryCount",
>     "value": "3"
> }
> ```

## 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](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1>) in the SailPoint Developer Community.

## Unlocked Okta Account Displays Incorrect Status

For Unlocked Okta accounts from SailPoint, 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 with **Manage user access**, select a group type other than **Everyone**.

## Account Preview does not work/displays any data on Okta application page

**Resolution** - To verify Okta accounts, run the account aggregation task instead of Account Preview. For more information on best practices of Okta account aggregation, refer to [Aggregation Best Practices](<https://documentation.sailpoint.com/connectors/okta/va/help/aggregation_best_practices.html>).

## 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/<groupID>/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 **Issuer** 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 **Subject** 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 **Audience** is correct for authorization.

## 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](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1>) 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](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1>) 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.

## Account Aggregation Fails with a Connection Pool Shut Down Error

Account aggregation fails with the following error message:

```text
Unable to create iterator sailpoint.connector.ConnectorException: java.lang.IllegalStateException: Connection pool shut down
```

**Resolution**: Removing the Caching Parameters from the source configuration.

```text
<entry key="appCacheThreadSize" value="4"/>
<entry key="applicationSkinnyUsers" value="true"/>
<entry key="enableMultiThreadedCacheCreationApps" value="true"/>
<entry key="enableMultiThreadedCacheCreationGroups" value="true"/>
<entry key="groupCacheThreadSize" value="4"/>
<entry key="groupSkinnyUsers" value="true"/>
```

Re-run the Account Aggregation.

# Timeout Errors and Settings

Timeout errors might occur when SailPoint is waiting for a response from the Virtual Appliance (VA). These errors are applicable to all connectors and tend to occur during the setup of sources or when sources are down.

This document is designed to give specific information that can be used to resolve these errors.

Each timeout attribute has a default time value that is listed in seconds or minutes. Increasing the time value may resolve the error as it will allow for longer communication time between the two systems, thus avoiding the timeout error.

> [!IMPORTANT]
>
> Add the necessary attributes or values before performing the "replace" operation, as missing attributes will cause the operation to fail.

To increase the communication time, increase the value of the appropriate timeout attribute. Then submit the change to the VA using the SailPoint REST API.

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

### aggregateTimeout

**Description:** This parameter is set for the aggregation timeout, measured in seconds.

**Resolution:** Increase the `aggregateTimeout` value gradually to optimize aggregation. Start with 180, then increase to 600, 900, and finally 1800. The maximum value is 3600 seconds.

For example:

If your current time value is 180 seconds, update the `aggregateTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/aggregateTimeout",
        "value": 600
    }
]
```

### healthCheckTimeout

**Description:** This parameter is set for the test connection and health check timeout.

**Resolution:** The default value is 30 seconds. If the timeout error continues, increase the value in 15 second increments and try again.

For example:

If your current time value is 30 seconds, update the `healthCheckTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/healthCheckTimeout",
        "value": 45
    }
]
```

### provisioningTimeout

**Description:** This parameter is set for provisioning timeout.

**Resolution:** Increase the `provisioningTimeout` value gradually to optimize provisioning. Start with 180, then increase to 360, and finally 600. The maximum value is 600 seconds.

For example:

If your current time value is 180 seconds, update the `provisioningTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/provisioningTimeout",
        "value": 360
    }
]
```

### timeout

**Description:** This parameter is set for pass-through authentication timeout.

**Resolution:** The default value is 15 seconds. If the timeout error continues, increase this value in 15 second increments and try again.

For example:

If your current time value is 15 seconds, update the `timeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeout",
        "value": 30
    }
]
```

### apiTimeout

**Description:** This parameter is set for API time tracking; customers can check it using an external tool.

**Resolution:** The default value is 60 seconds. If the error continues, increase the value by 15 second increments and try again.

For example:

If your current time value is 60 seconds, update the `apiTimeout` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/apiTimeout",
        "value": "75"
    }
]
```

### timeoutInSeconds

**Description:** This parameter helps prevent the VA from waiting indefinitely for an API response, ensuring efficient handling of API requests.

For example:

If your current time value is 30 seconds, update the `timeoutInSeconds` attribute as follows:

```json
[
    {
        "op": "replace",
        "path": "/connectorAttributes/timeoutInSeconds",
        "value": "15"
    }
]
```