# SailPoint Akeyless SaaS Connector Documentation > Akeyless SaaS Connector Documentation # Documentation # Connecting SailPoint and Akeyless SaaS To connect SailPoint with Akeyless, 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. 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) Select **Create Manual Work Items** to allow the connector to create manual work items for certain operations. You can also enable this option so the source supports additional source management features such as creating accounts and access profile management. > **Important** > > Once you enable this feature, you cannot disable it. For more information on manual work items in SailPoint, refer to [Work Items](). For more information on SailPoint features, refer to [SailPoint Identity Services](). 7. Select **Save**. ## Connection Settings Provide the values required for SailPoint to connect to Akeyless SaaS. Configure the credentials for the authentication method you created in [Prerequisites](). > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() To configure connection settings, complete the following: 1. In the **Akeyless API URL** field, enter the base API endpoint URL for your Akeyless instance. The default URL is `https://api.akeyless.io`. 2. Under **Authentication Type**, select the authentication method configured in Akeyless: - **API Key** - Authenticates using a static pair of Access ID and Access Key. - **Universal Identity** - Authenticates using machine identity tokens (UID Token). 3. In the **Access ID** field, enter the unique identifier associated with your authentication method in Akeyless (for example, `p-xxxxxxx`). 4. Provide the credential for the selected authentication method: - **If you selected API Key**: - Select **Static Value** to enter the secret access key directly. - Select **Credential Path** to specify the external vault or file path where the key is stored. - **If you selected Universal Identity**: - Select **Static Value** to enter the UID token directly. - Select **Credential Path** to specify the external vault or file path where the token is stored. 5. 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 Akeyless 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 Resources | | --- | --- | --- | | Akeyless Items | Credential | [Akeyless Item](<#akeyless-item>) | ## Supported Resources A resource represents a type of object the connector collects from the connected system (such as credentials). Each resource defines the attributes collected for that object type (such as name, ID, or status) and how each object appears in SailPoint. 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. ## Akeyless Item Akeyless Item is a credential resource. The connector aggregates item metadata only. It does not retrieve secret values. | Field | Value | | --- | --- | | Resource ID | `akeyless:item` | | Resource type | `std:credential` | | Identity attribute | `id` | | Display attribute | `itemName` | The following table lists schema attributes for the Akeyless Item resource: | Attribute | Description | Type | Entitlement | Multi-valued | | --- | --- | --- | --- | --- | | clientPermissions | The effective capabilities on the item. | String | No | Yes | | creationDate | The creation timestamp of the item. | String | No | No | | deleteProtection | Indicates whether delete protection is enabled (`true` or `false`). | Boolean | No | No | | format | The stored value format for the item (for example, `text`). | String | No | No | | id | The item ID. | String | No | No | | isEnabled | Indicates whether the item is enabled (`true` or `false`). | Boolean | No | No | | itemName | The item name and full path. | String | No | No | | lastModified | The last modification timestamp of the item. | String | No | No | | lastVersion | The current version number. | String | No | No | | maxVersions | The version-history retention limit. | String | No | No | | spStatus | The status of the item (`Active` or `Inactive`). | String | No | No | | subType | The item sub-type (for example, `generic`). | String | No | No | | tags | The tags assigned to the item. | String | No | Yes | | type | The item type (for example, `STATIC_SECRET`). | String | No | No | # Integrating SailPoint with Akeyless SaaS The SailPoint Akeyless SaaS connector is a read-only connector. It provides metadata-only visibility into Akeyless items so you can inventory managed secrets as credentials in SailPoint. The connector authenticates to the Akeyless REST API using an API Key or Universal Identity authentication method. It validates connectivity without retrieving secret values. For more information, refer to [Supported Features](<#supported-features>). This guide describes how to connect SailPoint to Akeyless. To bring Akeyless SaaS credentials into SailPoint, create a direct connect source using Express Setup or Standard Setup. After you configure the source, use [Dataset Management]() to configure owner correlation and dataset aggregation, discover Akeyless Item resources, and govern them in SailPoint. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SailPoint Akeyless SaaS connector is a read-only connector. It supports the following features: | Feature | Description | | --- | --- | | Test Connection | Validates authentication and connectivity to the Akeyless API. A successful test confirms that SailPoint can reach the API over HTTPS and exchange the configured credentials for a session token. | | Dataset Aggregation | Discovers Akeyless Item metadata managed in Akeyless. Secret values are not retrieved. | ### Non-Human Identity Discovery - Aggregate Akeyless Items (item metadata only; secret values are not retrieved) Refer to Dataset Management for more information. Refer to [Discovering Potential Non-Human Accounts]() for more information. ## Supported Managed Systems The SailPoint Akeyless SaaS connector supports the following managed systems: - Akeyless Vault public SaaS (`https://api.akeyless.io`) ## Prerequisites The Akeyless SaaS connector authenticates using one of two Akeyless authentication methods. Create the matching authentication method in Akeyless and attach a read-only role. The following table describes the credentials you provide in SailPoint: | Method | Access type | Credentials | | --- | --- | --- | | API Key | `access_key` | Access ID and Access Key | | Universal Identity | `universal_identity` | Access ID and UID Token | ### Creating an Authentication Method in Akeyless In the Akeyless Console, create the authentication method the connector will use. UI labels can vary by Akeyless release. For UI-specific steps, refer to [Akeyless documentation](). > [!NOTE] > > The linked document is not maintained by SailPoint and is subject to change without notice. #### API Key 1. Go to **Users & Access \> Authentication Methods**. 2. Select **New \> API Key**. 3. Enter a descriptive name, for example `SailPoint_ISC_API_Key`. 4. Save the authentication method, then copy and store the generated **Access ID** and **Access Key**. The Access Key is shown only once. #### Universal Identity 1. Go to **Users & Access \> Authentication Methods**. 2. Select **New \> Universal Identity**. 3. Enter a descriptive name, for example `SailPoint_ISC_Universal`. 4. Save the authentication method, then copy and store the **Access ID** and generate a **UID Token** for the connector. > [!NOTE] > > Store the Access Key or UID Token securely. SailPoint uses it to obtain a session token. The value in Akeyless must match the value configured in Connection Settings. ### Creating a Read-Only Access Role 1. Go to **Users & Access \> Roles**. 2. Create a new role, for example `SailPoint_ReadOnlyRole`. 3. Grant read-only permissions on the paths the connector reads. For more information, refer to [Required Permissions](<#required-permissions>). 4. Associate the role with the authentication method by its Access ID. ## Required Permissions The Akeyless authentication method, through its attached role, must have read-only capabilities. For Test Connection, the ability to authenticate (`POST/auth`) is sufficient. For the read-only, grant **List** and **Read** on the following: - Items (secrets metadata) > [!NOTE] > > All access is metadata-only. # 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](). ## Test Connection fails with an authentication error (HTTP 401 or 403) The following error might appear when you select **Test Connection**: ```text Authentication failed. Please check the credentials in Connection Settings. ``` SailPoint returns a generic authentication message by design and includes a request ID for support correlation. **Resolution**: Confirm that the **Access ID** and the **Access Key** or **UID Token** in [Connection Settings]() match the authentication method in Akeyless. Confirm that the authentication method is still enabled and that the Access Key or UID Token was not rotated without updating SailPoint. ## SailPoint cannot reach the Akeyless API Test Connection fails because SailPoint cannot reach the Akeyless API host. **Resolution**: Confirm that **Akeyless API URL** uses the correct host and the HTTPS scheme. For public SaaS, use `https://api.akeyless.io`. For a dedicated or self-hosted deployment, use your tenant API URL. Confirm that network and firewall rules allow traffic from SailPoint to that URL. The URL must use HTTPS. ## Test Connection fails with a not found (HTTP 404) response The Akeyless API returns HTTP 404 when the request URL does not match your deployment. **Resolution**: Verify that **Akeyless API URL** is correct for public SaaS. For more information, refer to [Supported Managed Systems](). ## Test Connection or aggregation is rate limited (HTTP 429) Akeyless returns HTTP 429 when SailPoint sends too many requests in a short period. **Resolution**: Wait, then select **Test Connection** again. The connector retries automatically. If the error continues, reduce concurrent test or aggregation activity against the same Akeyless tenant. ## Test Connection fails because of a TLS or certificate problem The connection fails during TLS handshake or certificate validation for the Akeyless API URL. **Resolution**: Confirm that the certificate for the Akeyless API host is valid and matches the hostname in **Akeyless API URL**. Check for TLS inspection, expired certificates, or a hostname mismatch.