# SailPoint OpenAI SaaS Connector Documentation > OpenAI SaaS Connector Documentation # Documentation # Connecting SailPoint and OpenAI SaaS To connect SailPoint with OpenAI, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings The following values are required for SailPoint to connect to your OpenAI organization. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. Enter the **Admin API Key** used to validate organization-level access and perform connector operations. Organization-level Admin API Key used for test connection, account aggregation, entitlement aggregation, provisioning, and most dataset operations. SailPoint stores this value as a secret. 3. Select **Save**. ## Aggregation Settings Open **Aggregation Settings** to scope account and dataset collection. > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Select **Aggregation Settings** from the menu. 2. (Optional) Select one or more OpenAI projects to include in aggregation. If no project is selected, all projects in the organization are included. 3. Save a valid **Admin API Key** first, then refresh to load project options. 4. Select **Save**. ## Advanced Settings > [!NOTE] > > **Screenshot** > > [![Advanced Settings]()]() 1. Select **Advanced Settings** from the menu. 2. Configure the **Connection Timeout** in minutes. By default, the connection timeout is 1 minute. 3. In **Page Size** enter the number of records to fetch in one request. The minimum value is 1 and the maximum value is 1000. By default, the page size is 100. 4. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Dataset Management Dataset Management lets you review the object types a source collects and control how the source aggregates those objects into SailPoint. Use Dataset Management to view and manage resource attributes, datasets and their resources, enable dataset aggregation schedules, perform manual aggregation, and view aggregation history. > [!NOTE] > > Datasets are also available in SailPoint Agentic Fabric. Contact your Customer Success team and refer to [SailPoint Agentic Fabric]() for more information. For more information, refer to [Managing Datasets and Resources]() for datasets, resources, owner correlation, and aggregation. ## Datasets A *dataset* is a named group of one or more related resources that the source aggregates together. When aggregation runs for a dataset, the source collects all resources in that dataset from the managed system in one aggregation job. Activate or deactivate aggregation at the dataset level, not for individual resources. > [!NOTE] > > Each resource belongs to exactly one dataset for that source. The source defines which resources belong to each dataset. You can enable aggregation and review associated resources, but you cannot create or delete datasets or move resources between them. ### Dataset Aggregation Configure aggregation on the **Dataset Aggregations** tab for each dataset. Configure each dataset separately. During aggregation, your owner correlation rules are automatically applied to link machine identities to their human owners. For more information, refer to [Configuring Dataset Aggregations](). ## Resources A resource defines an object type from the managed system. It specifies the kind of object, the attributes the source collects, and how the source identifies and displays each object. Resources form the building blocks of the data model. In the UI, each resource appears under **Dataset Management** \> **Resources** with its schema. A resource does not run aggregation by itself. The dataset that owns the resource collects it during aggregation. For more information, refer to [Managing Resources](). ### Owner Correlation Configure owner correlation on each resource to link aggregated objects to human owners. If you do not configure owner correlation, or if the mapping produces no match, an owner is not assigned. For more information, refer to [Configuring Owner Correlation](). ## Supported Datasets Go to **Dataset Management \> Datasets** on your OpenAI SaaS source to view the datasets the connector aggregates. Select a dataset to review its associated resources and configure aggregation. > [!NOTE] > > Configure aggregation for each dataset separately. For more information, refer to [Dataset Aggregation](). The connector uses datasets to schedule aggregation of the following resource types: | Dataset | Resource Type | Associated Resource | | --- | --- | --- | | OpenAI API Keys | Credential | [OpenAI API Key](<#openai-api-key>) | | OpenAI Certificates | Credential | [OpenAI Certificate](<#openai-certificate>) | ## Supported Resources For more information, refer to [Managing Resources](). > [!NOTE] > > When you enable dataset aggregation for a selected dataset, all resources in that dataset are collected at once. Activate or deactivate aggregation at the dataset level, not for individual resources. The OpenAI datasets include the following resources, which the connector aggregates as machine identities: | Resource Name | Resource Type | Resource ID | | --- | --- | --- | | [OpenAI API Key](<#openai-api-key>) | Credential | `openai:api-key` | | [OpenAI Certificate](<#openai-certificate>) | Credential | `openai:certificate` | ## OpenAI API Key | Property | Value | | --- | --- | | Resource ID | `openai:api-key` | | Resource type | `std:credential` | | Identity attribute | `id` | | Display attribute | `name` | The following table lists schema attributes for the OpenAI API Key resource: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | id | The unique identifier of the OpenAI API key. | String | No | No | | name | The display name of the API key. | String | No | No | | keyScope | The scope of the key. The value is `organization` or `project`. | String | No | No | | objectType | The source object type returned by OpenAI. | String | No | No | | createdAt | The time the API key was created. | String | No | No | | expiresAt | The time the API key expires. | String | No | No | | lastUsedAt | The last time the API key was used. | String | No | No | | ownerType | The category of the API key owner. | String | No | No | | ownerId | The identifier of the API key owner. | String | No | No | | ownerName | The display name of the API key owner. | String | No | No | | ownerRole | The role of the API key owner. | String | No | No | | ownerCreatedAt | The time the API key owner identity was created. | String | No | No | | redactedValue | The redacted API key value returned by OpenAI. | String | No | No | | adminApiKey | Indicates whether the key is an organization admin API key (`true` or `false`). | Boolean | No | No | | projectName | The display name of the project for a project-scoped API key. | String | No | No | | spBusinessApplication | The business application label used for governance correlation. | String | No | No | | spStatus | The governance lifecycle status of the API key. | String | No | No | | spDescription | The governance description of the API key. | String | No | No | ## OpenAI Certificate | Property | Value | | --- | --- | | Resource ID | `openai:certificate` | | Resource type | `std:credential` | | Identity attribute | `certificateId` | | Display attribute | `name` | The following table lists schema attributes for the OpenAI Certificate resource: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | certificateId | The unique identifier of the OpenAI certificate. | String | No | No | | name | The display name of the OpenAI certificate. | String | No | No | | objectType | The source object type returned by OpenAI. | String | No | No | | createdAt | The time the certificate was uploaded. | String | No | No | | validAt | The time the certificate becomes valid. | String | No | No | | expiresAt | The time the certificate expires. | String | No | No | | active | Indicates whether the certificate is active at the aggregated scope (`true` or `false`). | Boolean | No | No | | spBusinessApplication | The business application label used for governance correlation. | String | No | No | | spStatus | The governance lifecycle status of the certificate. | String | No | No | | spDescription | The governance description of the certificate. | String | No | No | # Integrating SailPoint with OpenAI SaaS This guide describes how to connect SailPoint to OpenAI so you can run test connection, account and entitlement aggregation, provisioning, and dataset aggregation for governance-relevant objects - for example organization users, roles and groups, API keys, and certificates as machine identities. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features | Feature | Description | | --- | --- | | Test Connection | Validates access to the OpenAI Administration API with the configured admin API key. | | Account Aggregation | Aggregates OpenAI organization users, project memberships, and assigned entitlements. | | Entitlement Aggregation | Aggregates organization roles, project roles, and groups that can be assigned to users. | | Provisioning | Supports entitlement assignment and removal of organization roles, project roles, and groups. The connector also supports account delete (remove user from the organization). | | Dataset Aggregation | Aggregates OpenAI API keys and certificates as machine identities. | ### Non-Human Identity Discovery - Aggregate OpenAI API keys and certificates Refer to Dataset Management for more information. Refer to [Discovering Potential Non-Human Accounts]() for more information. ## Prerequisites Before you configure the source, create an OpenAI admin API key with the permissions required to aggregate users, entitlements, API keys, and certificates and to provision access. SailPoint recommends using a dedicated service account or administrator identity approved by your organization. ### Create an OpenAI Admin API Key SailPoint authenticates to OpenAI using an **Admin API Key** configured on the source (the key is stored as a secret). 1. Sign in to the OpenAI Platform with an account your organization approves for integration (a dedicated service account or admin identity is recommended). 2. Open your organization settings and create an **Admin API Key** with the read and write permissions your governance program requires. 3. Copy the key immediately and store it in your secrets tooling. You will paste it into SailPoint as **Admin API Key**. Once you close the key window, the secret value is not shown again. 4. Grant only the access required for the operations you enable: user and entitlement aggregation, provisioning, and dataset collection (API keys, certificates). For information about creating and managing API keys, refer to [OpenAI API Authentication](). > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The OpenAI SaaS connector uses the following default correlation and object configurations. ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account Attributes The OpenAI SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. The following table lists the OpenAI account schema attributes: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | id | The unique identifier of the user in the OpenAI organization. This is the identity attribute. | String | No | No | | name | The display name of the user. This is the display attribute. | String | No | No | | email | The primary email address of the user. | String | No | No | | objectType | The OpenAI object type of the user record. | String | No | No | | addedAt | The time the user was added to the OpenAI organization. | String | No | No | | apiKeyLastUsedAt | The last time the user used an API key. | String | No | No | | createdAt | The time the user identity was created. | String | No | No | | developerPersona | The developer persona metadata returned by OpenAI. | String | No | No | | technicalLevel | The technical level metadata returned by OpenAI. | String | No | No | | isServiceAccount | Indicates whether the account is a service account (`true` or `false`). | Boolean | No | No | | isScimManaged | Indicates whether SCIM manages the account (`true` or `false`). | Boolean | No | No | | isDefault | Indicates whether this is the default account (`true` or `false`). | Boolean | No | No | | isScaleTierAuthorizedPurchaser | Indicates whether the user is authorized to purchase the Scale Tier (`true` or `false`). | Boolean | No | No | | projectMemberships | The projects in which the user has membership. | String | No | Yes | | orgRoleIds | The organization-level roles assigned to the user. | String | Yes | Yes | | projectRoleIds | The project-scoped roles assigned to the user. | String | Yes | Yes | | groupIds | The groups assigned to the user. | String | Yes | Yes | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Object Type: orgRole The following table lists the attributes for the orgRole entitlement: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | id | The unique identifier for the organization role. This is the entitlement ID. | String | No | No | | name | The organization role name. This is the entitlement name. | String | No | No | | description | The role summary for the organization role. | String | No | No | | permissions | The permission set granted by this role. | String | No | Yes | | resourceType | The resource boundary for the role. For example, `api.organization`. | String | No | No | | predefinedRole | Indicates whether OpenAI predefined the role (`true` or `false`). | Boolean | No | No | | objectType | The OpenAI object type. Always set to `role`. | String | No | No | ### Object Type: projectRole The following table lists the attributes for the projectRole entitlement: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | id | The unique identifier for the project role, in the form `projectRole::`. This is the entitlement ID. | String | No | No | | name | The project role name. This is the entitlement name. | String | No | No | | projectId | The identifier of the OpenAI project associated with the role. | String | No | No | | projectName | The display name of the OpenAI project associated with the role. | String | No | No | | description | The role summary for the project role. | String | No | No | | permissions | The permission set granted by this role. | String | No | Yes | | resourceType | The resource boundary for the project role. | String | No | No | | predefinedRole | Indicates whether OpenAI predefined the role (`true` or `false`). | Boolean | No | No | | objectType | The OpenAI object type. Always set to `role`. | String | No | No | ### Object Type: Group The following table lists the attributes for the group entitlement: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | id | The unique identifier for the group, in the form `group:`. This is the entitlement ID. | String | No | No | | name | The group name. This is the entitlement name. | String | No | No | | description | The description of the group. | String | No | No | | objectType | The OpenAI object type. The expected value is `organization.group`. | String | No | No | | memberCount | The number of users in the group. | Integer | No | No | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings]().