# SAP Identity Directory SaaS Connector > SailPoint SAP Identity Directory SaaS Connector Documentation # Documentation # Connecting SailPoint and SAP Identity Directory SaaS To connect SailPoint with SAP Identity Directory, 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 To configure the SAP Identity Directory SaaS connector with **Authentication Type** is `Basic`: > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the host URL of the SAP Identity Directory in the **Host URL**. 2. By default, **Authentication Type** is `Basic`. 3. Enter the **Client ID** of the Cloud Identity Services technical user. 4. Enter the **Client Secret** of the Cloud Identity Services technical user. 5. Select **Save**. To configure the SAP Identity Directory SaaS connector with **Authentication Type** is `OAuth 2.0`: > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the host URL of the SAP Identity Directory in the **Host URL**. 2. Set **Authentication Type** to `OAuth 2.0`. 3. **Grant Type** defaults to **Client credentials.** 4. Enter the **Client ID** of the Cloud Identity Services technical user. 5. Enter the **Client Secret** of the Cloud Identity Services technical user. 6. Enter the **Token URL** of the Cloud Identity Services OAuth token endpoint. 7. Select **Save**. > [!NOTE] > > For more information on creating credentials of the SAP Identity Directory, refer to [Steps for creating a technical user and its credentials](). ## Aggregation Settings Provide the following settings requirement for aggregation: For more information about aggregation, refer to [Loading Account Data](). ### Page Size Settings > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Enter the number of records in the **Page Size** to aggregate in a single page when iterating over large datasets. You can set it from 10 to 500. The default is 100 records. 2. Select **Save**. ### Filter Settings > [!NOTE] > > **Screenshot** > > [![Filter Settings]()]() 1. Enter the query expressions for filtering users based on status or parameters before they are aggregated in SailPoint. For example, `userName sw "A" or active eq true` > **Note** > > For multiple and complex query expression, you can use `AND` and `OR`. 2. Select **Save**. > **List of Supported Operators for Filtering Users** > > | Supported Operator | Definition | > | --- | --- | > | eq | Equal to | > | ne | Not equal to | > | sw | Starts with | > | gt | Greater than | > | lt | Less than | > | and | Returns a match only if both expressions evaluate to true | > | or | Returns a match if either expression evaluates to true | For more information on supported user search attributes, refer to [User Search Attributes](<#user-search-attributes>). ### User Search Attributes The following lists the supported user search attributes: #### Core Schema Attributes - id - externalId - userName (supports empty string filtering) - userType - name.givenName - name.familyName - emails.value - phoneNumbers.value (URI encoding required for reserved characters like +) - groups.display - addresses.locality - addresses.region - addresses.postalCode - addresses.country - displayName For example, `userName sw "A"` #### Enterprise User Resource Schema Attributes - employeeNumber - costCenter - organization - division - department - manager.value Use the following schema extension to filter Enterprise User Resource schema attributes: `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` For example, `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber eq "1234"` #### SAP Extension Schema Attributes - userUuid - validFrom - validTo Use the following schema extension to filter Enterprise User Resource schema attributes: `urn:ietf:params:scim:schemas:extension:sap:2.0:User` For example, `urn:ietf:params:scim:schemas:extension:sap:2.0:User:userUuid eq "11111-111-1-1-1"` > [!NOTE] > > Above listed attributes are supported by default for filtering users. In addition to these attributes, SAP supports filtering on other attributes when they are added to the account schema in SailPoint. For more details on these additional attributes and their implementation, reach out to SAP support. ## 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. # Frequently Asked Questions This Frequently Asked Questions (FAQs) section provides answers to the most commonly asked questions for SailPoint. ## Why do I get a 400 Bad Request error when applying a filter with an empty value? Filtering based on an empty value is supported only for the `userName` attribute. If you attempt to filter on any other attribute, the API will return a 400 Bad Request error. # Integrating SailPoint with SAP Identity Directory SaaS > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. SAP introduced the persistent layer called as Identity Directory to store and manage users, groups, and custom schemas in a central location for SAP Cloud Identity Services. The SAP Identity Directory provides a system for Cross-domain Identity Management (SCIM) 2.0 REST API for managing resources (users, groups and custom schemas) & follows [RFC 7643](). Provisioning of users and managing the entitlements in the SAP Identity Directory to ensure correct access and managing joiner-mover-leaver workflow is achieved through the SailPoint's SAP Identity Directory integration. To know more about SAP Identity Directory based Integration scenarios, refer to [SAP Identity Directory](). This document is designed to give specific information about the requirements and field definitions needed to get a working instance of a SAP Identity Directory SaaS connector. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SAP Identity Directory SaaS connector supports the following features: ### Aggregation - Account Aggregation - Groups Aggregation ### Add/Remove Entitlement - Groups ### Account Provisioning - Create User - Update User (Attributes) - Enable/Disable User ## Supported Managed Systems The SAP Identity Directory SaaS connector supports the following managed systems: - Cloud Identity Services (SAP Identity Directory) ## Prerequisites Following are the prerequisites to use SailPoint SAP Identity Directory SaaS connector: - System administrator must have access to Cloud Identity Services (bundled or standalone) tenant. - The Identity Directory SCIM 2.0 API can only manage resources stored in the Identity Directory persistency layer. To utilize the Identity Directory for identity governance, it is necessary to load identities into it through provisioning from an external IdP or HR source, CSV import, or manual creation. ### Steps for creating a technical user and its credentials Following are the steps for creating a technical user and its credentials that you can use to communicate with SAP Identity Directory: 1. In the SAP Cloud Identity Services admin console, go to **Users & Authorizations \> Administrators**. 2. Add an administrator user of type **System**, provide name of the user. 3. Select `Read Users`, `Manage Users`, and `Manage Groups` permission in **Configure Authorizations**. 4. Select **Save**. 5. Go to **Configure System Authentication \> Secrets \> Add**. 6. Copy and save the **Client Secret** and **Client ID**. ## Required Permissions In the SAP Identity Directory, create a technical user (System User) and its credentials with the following permissions: - Read Users - Manage Users - Manage Groups For more information, refer to [Steps for creating a technical user and its credentials](<#steps-for-creating-a-technical-user-and-its-credentials>). # Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. # Provisioning The SAP Identity Directory SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in SAP Identity Directory 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 > [!IMPORTANT] > > Account attributes marked with an asterisk(\*) are mandatory attributes for account creation. | Account Attribute | Type | Generator | Description | | --- | --- | --- | --- | | \*User Name | String | Identity Attribute - Username | The user's username. | | \*First Name | String | Identity Attribute - Given Name | The user's first name. | | \*Last Name | String | Identity Attribute - Family Name | The user's last name. | | \*Email | String | Identity Attribute - Work Email | The user's email address. | | \*Display Name | String | Identity Attribute - Display Name | The name of the user, suitable for display to end-users. | | User Type | String | Disabled | The type of user used to identify the relationship between the organization and the user. | - To enable initial password during the account creation process, select **Add Mapping** to create a new attribute in the **Create Account** section with the value `password`. The password should be atleast 8 characters long and include a mix of uppercase and lowercase letters, numbers, and special symbols. > [!NOTE] > > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication]() and [REST API - Update Source (Partial)]() in the SailPoint Developer Community. # 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 SAP Identity Directory SaaS connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the SAP Identity Directory SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | ID | Equals | Username | | Email | Equals | Work Email | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | ID | Account | | ID | Group | ### Default Account Attributes The SAP Identity Directory SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. > [!NOTE] > > SAP Cloud Identity Directory Custom Attributes(1-10) are now supported. Please add schema attribute as 'customAttribute1'. For more information refer [Connector support for Additional schema attributes]() | Attribute Name | Description | | --- | --- | | Active | A boolean value indicating the users administrative status. | | Corporate Group | A list of user's corporate groups. | | Cost Center | The user's cost center. | | Country | Country used in street address. | | Department | The user's department. | | Display Name | The name of the user, suitable for display to end-users. | | Division | The user's division. | | Email | The user's primary work email address. | | Employee Number | A numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization. | | External ID | An identifier for the user as defined by the provisioning client. | | First Name | The user's first name. | | Groups | A list of groups to which the user belongs. | | ID | A unique identifier for the user. | | Industry | The user's industry. | | Is Email Verified? | A boolean value indicating user email vefification status. | | Language | The user's preferred written or spoken language. | | Last Name | The user's last name. | | Locale | The user's email verification status. | | Locality | Locality used in street address. | | Manager | The user's primary supervisor username. | | Middle Name | The user's middle name. | | Organization | The user's organization name. | | Phone | The user's primary work phone number. | | Password Policy | The user's password policy. | | Password Status | The user's password status. | | Postal Code | Postal Code used in street address. | | Region | Region used in street address. | | Relationship | The user's association with the organization. | | SAP User Name | The user's SAP user name. | | Salutation | A formal title used before the user's name. | | Source System | The password authentication provider type. | | Source System ID | The password authentication provider ID. | | Street Address | The user's street address. | | Timezone | The users time zone in the Olson time zone database format. For example, America/Los\_Angeles | | Title | The users title, such as Vice-President. | | User Name | The user's login name or user name. | | User Type | The type of user used to identify the relationship between the organization and the user. | | User ID | The user's ID. | | User UUID | The user's unique identification number. | | Valid From | The user's valid from date. | | Valid To | The user's valid to date. | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The SAP Identity Directory SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. | Attribute Name | Description | | --- | --- | | ID | A unique identifier for the group. | | Display Name | The group's display name. | | Description | The group's description. | | Members | The members of the group. | # 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](). ## Email address includes uppercase characters The following error message appears, if email address includes any uppercase characters: ```text 2024-08-22T18:23:32,161 WARN QuartzScheduler_Worker-4 sailpoint.connector.testframework.IIQConnectorValidator:1200 - extracting errors from ProvisioningPlan attrName: Email : attrValue: xxxxxxxxxUPPERCASE@xxxx.com : failed : Error Msg: null ``` **Resolution**: Ensure to provide email address in lowercase. ## Account aggregation does not promote groups as entitlements, resulting in groups not being populated in the entitlement catalog. **Resolution**: Mark the entitlement as true for the group account schema attribute, as shown in the attached screenshot. > [!NOTE] > > **Screenshot** > > [![Troubleshooting]()]()