# SailPoint SAP HANA Connector Documentation > SAP HANA Connector Documentation # Documentation # Connecting SailPoint and SAP HANA To connect SailPoint with SAP HANA, 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 **Configure**. 5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 6. 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. 7. 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](). 8. 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](). - **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. 9. 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. 10. (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](). 11. 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](). 12. 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](). 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](). 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](). 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**. ### Connector Files > [!NOTE] > > **Screenshot** > > [![Connector Files]()]() 1. Upload the .jar file used for the source. The .jar file in this case is the `ngdbc.jar` file located in the `\hdbclient` directory, where `` is the SAP Client Installation directory. > **Warning** > > Ensure that the file you upload is not vulnerable or malicious. 2. Select **Save**. ## Connection Settings > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **Username** of the SAP HANA service account that is used for the source. 2. Enter the **Password** associated to the user. 3. Enter the SAP HANA **Database URL**. - **Default Database**: `jdbc:sap://:/?databaseName=` - **SAP HANA Cloud Database**: `jdbc:sap://SQL-ENDPOINT/?encrypt=true` For more information, refer to the [SAP Help Portal](). Where: - ``: is the server name where the SAP HANA database is installed. - ``: is the port on which the database is configured. - ``: is the name of the database to connect to. - `SQL-ENDPOINT`: is the SQL Endpoint contain the SAP HANA Cloud database instance ID and port. The specified default URL is provided for the multi-tenant HANA Database system. For a single tenant HANA Database system, the attribute database name is not applicable. 4. Enter the **Driver Class** of the jar file used for the source. 5. Select **Save**. ## Additional Configuration > [!NOTE] > > **Screenshot** > > [![Additional Configuration]()]() 1. Enter the **Page Size**, which is the number of records that you want to aggregate in a single page. 2. SAP HANA supports aggregation of future dated accounts. Use the **Aggregate Future Dated Accounts** option to change the behavior for Enable and Disable operations. After adding the `manageFutureDatedAccounts` attribute: - Disabling the account deactivates the user and sets the user's end date to the current date. - Enabling the account activates the user and sets the user's start date to the current date. SAP HANA supports the following attributes for updating an account: - `IS_CLIENT_CONNECT_ENABLED` - `EMAIL_ADDRESS` - `TIME_ZONE` - `VALID_FROM` - `VALID_UNTIL` - `DISABLE_PASSWORD` - `IS_RESTRICTED` 3. Use the **Aggregate Terminated Accounts** toggle if you want to aggregate inactive users whose valid end date is in past. Specify the **Effective Date** in the MM/DD/YYYY format from when you want to aggregate the terminated accounts. The date must not be in the future. The **Effective Date** is only applicable if you enable the **Aggregate Terminated Accounts** option. The value of the Effective Date is mapped to the 'Valid\_Until' date for the inactive users. Using the **Aggregate Terminated Accounts** option changes the behavior for the Enable and Disable feature: - Disabling the account operation deactivates the user and sets the user's end date to the current date. - Enabling the account operation activates the user and sets the user's start date to the current date. 4. Select **Save**. ### Provisioning Settings Configure settings related to provisioning operations. #### Revoke Catalog Roles By default, users can only revoke catalog roles that they grant to other users. You can allow users to revoke catalog roles that were granted by other users. To revoke roles granted by others, the service account must either have the `ROLE ADMIN` system privilege or be assigned the same catalog role with the `ADMIN OPTION`. > [!NOTE] > > **Screenshot** > > [![Revoke Catalog Roles]()]() To enable users to revoke catalog roles granted by other users: 1. Enable **Revoke Catalog Roles Granted by Others**. 2. Select **Save**. ## SSL Connection The SAP HANA source supports SSL connections. Perform the following steps to enable the SSL connection to the SAP HANA database: 1. Import the SSL certificates from the SAP HANA Server to the `/home/sailpoint/certificates` directory on the source VA. 2. In the hosts.yaml file enter the SAP HANA Server in the `xxx.xx.xx.xxx ` format. > **Note** > > For information on creating a hosts.yaml file, refer to [Configuring a Hosts.yaml File](). 3. Restart the CCG with the `sudo systemctl restart ccg` command. 4. In the configuration of the SAP HANA source for the **Database URL** field, use the following URL mentioned in the SSL certificate: `jdbc:sap://:/?databaseName=&encrypt=true&hostNameInCertificate=` ## 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. ## Additional Authentication Resources For more information on utilizing authentication with your SAP HANA Database connector, refer to the following links on the SAP Help Portal: - For information on Kerberos and SAML 2.0 authentication, refer to [SAP HANA Authentication and Single Sign-On](). > **Note** > > The SailPoint SAP HANA connector currently supports password authentication only. If required, password creation can be disabled, which allows creation of a user without a password. The connector has been enhanced to provide support for Kerberos and SAML (Security Assertion Markup Language) authentication mechanisms along with password authentication. Users can be created by choosing any of the authentication options or all of the options together. - For more information on supported user authentication methods, refer to [Supported Authentication Methods](). - For more information on using single sign-on (SSO) using Kerberos, refer to [Single Sign-On Using Kerberos](). - For information on how Kerberos constrained delegation works, refer to [Introduction to Kerberos Constrained Delegation - SAP HANA Smart Data Access HANA to HANA Scenarios](). - For more information on using SSO using SAML 2.0, refer to [Single Sign-On Using SAML 2.0](). > [!NOTE] > > The SAP HANA connector supports SAP HANA Cloud database, which allows the creating of a user with password authentication and SAML authentication methods. User creation with Kerberos authentication is not supported in when using SAP HANA Cloud database. # Integrating SailPoint with SAP HANA > [!NOTE] > > **Integration** > > This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager. SailPoint's SAP HANA Database connector offers a complete access management solution for your SAP HANA Database users and roles. This connector directly interacts to the database layer for SAP HANA. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The SAP HANA connector supports the following features: ### Account Management - Manages SAP HANA database users as Accounts - Aggregation, Refresh Accounts - Create, Update, Delete - Enable, Disable, Unlock, Change Password - Add/Remove Entitlements - Manages System Privileges and Application privileges of user ### Account - Group Management > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. - Load and \*Provision SAP HANA - Accounts - Repository roles - Catalog Roles - System privileges (loaded during account aggregation) - Application privileges (loaded during account aggregation) - Custom User Parameters. For more information, refer to [Custom User Parameters](). - \*Access Certifications (certification of entitlements connected to accounts) - \*Password management For more information on group aggregation, refer to [Group Aggregation Configuration](). For more information on features, refer to [Source Features](). ### 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](). ### 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](). ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). - Create a service account on the SAP HANA source with required permissions. - The SAP HANA JDBC driver must be set up for proper functioning of the SAP HANA source. > [!NOTE] > > In order to connect to the SAP HANA Cloud database, JDBC driver version 2.4.67 or greater is required. For more information, refer to the [SAP Help Portal](). ## Supported Managed Systems The SailPoint SAP HANA connector supports the following SAP systems: - SAP HANA Cloud Database Version 4.0x - SAP HANA 2.0 SPS8 - SAP HANA 2.0 SPS6 - SAP HANA 2.0 SPS5 - SAP HANA 2.0 SPS4 - SAP HANA 2.0 SPS3 - SAP HANA 1.0 SPS12 - SAP HANA 1.0 SPS11 ## Required Permissions The following are the required permissions for the specific operations mentioned below: > [!NOTE] > > - USER ADMIN privileges are required for Enable/Disable/Lock/Unlock Account/Delete Account/change password. > - For **SAP HANA Cloud** database, the USER ADMIN system privilege is not available and instead the OPERATOR system privilege on the user group in which the user is to be created is required for Enable/Disable/Lock/Unlock Account/Delete Account/change password. For more information, refer to the [SAP Help Portal](). ### Test Connection CATALOG role: PUBLIC ### Account Aggregation System Privileges - CATALOG READ - ROLE ADMIN - USER ADMIN ### Group Aggregation - CATALOG READ - ROLE ADMIN ### Removing the Role Assigned to the User Revoking the role can be achieved by the same user who has granted it. For information on enabling users to revoke catalog roles assigned by other users, refer to [Revoke Catalog Roles](). ### Creating a User by Assigning the Respective Privileges and Roles **Minimum required permissions for existing SAP HANA connector**: | CATALOG role and Application privilege | Repository roles | System Privileges | | --- | --- | --- | | System privileges
\- CATALOG READ
\- ROLE ADMIN | System Privileges
\- CATALOG READ
\- ROLE ADMIN
\- USER ADMIN

Object Privileges
EXECUTE Privilege on the following objects:
\- `_SYS_REPO.GRANT_ACTIVATED_ROLE`
\- `_SYS_REPO.REVOKE_ACTIVATED_ROLE`
\- `_SYS_REPO.GRANT_APPLICATION_PRIVILEGE`
\- `_SYS_REPO.REVOKE_APPLICATION_PRIVILEGE` | The service account must have the system privilege assigned to it with the **Grantable to other user and groups** flag enabled. | **Minimum required permissions for SAP HANA Cloud database connector**: | CATALOG role and Application privilege | Repository roles | System Privileges | | --- | --- | --- | | System privileges
\- CATALOG READ
\- ROLE ADMIN | System Privileges
\- CATALOG READ
\- ROLE ADMIN

Object Privileges
ALTER and REFERENCES object permissions are required on SAML provider object in order to provision user with the respective SAML provider for SAP HANA Cloud database.

**Note**: To grant a role created with the role group assigned, the object privilege OPERATOR on the role group is required. | The service account must have the system privilege assigned to it with the **Grantable to other user and groups** flag enabled. | # Machine Account Attributes Machine account attributes are used in provisioning configurations for machine accounts. After you have [created the required machine account subtypes](), you can use the machine account attributes to provision machine accounts in your SailPoint tenant. Refer to [Machine Identity Security Overview]() for more information. ## Machine Account Provisioning Attributes > [!NOTE] > > The SAP HANA connector does not provide out-of-the-box machine account classification. Configure classification criteria based on your governance standard, such as naming conventions or role assignment. Use the following table to map each machine account attribute to its display name, data type, requirement status, and usage notes. | Field (name) | Display Name | Type | Required | Notes | | --- | --- | --- | --- | --- | | `USER_NAME` | User Name | `string` | Yes | Native SAP HANA database user name for the machine account. The connector uppercases the value and rejects whitespace before issuing create SQL. | | `password` | Password | `secret` | Yes | Required unless password authentication is disabled and an external authentication method is configured. Use the **Create Password** generator. | | `FORCE_PWD_CHG_ON_NEXT_LOGON` | Force Password Change On Next Logon | `string` | No | Recommended default is `NO`. The connector maps `NO` to `NO FORCE_FIRST_PASSWORD_CHANGE`. Allowed values are `YES` and `NO`. | | `IS_RESTRICTED` | Restricted | `string` | No | Recommended default is `TRUE` for restricted application users and `FALSE` for standard technical users. When set to `TRUE`, the connector emits `CREATE RESTRICTED USER`. Restricted users require explicit JDBC/ODBC access and the `RESTRICTED_USER_JDBC_ACCESS` role when they must connect through JDBC/ODBC clients. Allowed values are `TRUE` and `FALSE`. | | `DISABLE_PASSWORD` | Disable Password | `boolean` | No | Recommended default is `false`. If set to `true`, the connector creates the user with a generated password and then runs `ALTER USER ... DISABLE PASSWORD`. Use only when another authentication mechanism is intended. | | `VALID_FROM` | Valid From | `string` | No | Optional validity start date and time. | | `VALID_UNTIL` | Valid Until | `string` | No | Optional validity end date and time. | | `SYSTEM_PRIVILEGES` | System Privileges | `string` | No | Assign only the minimum required system privileges at request time. | | `APPLICATION_PRIVILEGES` | Application Privileges | `string` | No | Assign only the minimum required application privileges at request time. | | `CATALOG_ROLES` | Catalog Roles | `string` | No | Assign catalog roles at request time. | | `REPOSITORY_ROLES` | Repository Roles | `string` | No | Assign repository roles at request time. For restricted JDBC access, include `RESTRICTED_USER_JDBC_ACCESS`. | | `IS_KERBEROS_ENABLED` | IS\_KERBEROS\_ENABLED | `boolean` | No | Use only when Kerberos authentication is intended and the external identity is known. Kerberos authentication is not supported when using SAP HANA Cloud database. | | `EXTERNAL_IDENTITY_KERBEROS` | External ID for Kerberos | `string` | No | Specifies the external identifier for Kerberos authentication. Use only when Kerberos authentication is intended. | | `IS_SAML_ENABLED` | IS\_SAML\_ENABLED | `boolean` | No | Use only when SAML authentication is intended and identity-provider mapping is configured. | | `SAML_PROVIDER` | Identity Provider Name | `string` | No | Specifies the SAML identity provider name. Use only when SAML authentication is intended. | | `EXTERNAL_IDENTITY_SAML` | External ID for SAML | `string` | No | Specifies the external identifier for SAML authentication. Use only when SAML authentication is intended. | | `SAML_PROVIDERS` | SAML Providers List | `string` | No | Enter SAML provider names and external identifiers in the format `Provider::ExternalIdentifier`. Separate multiple values with a comma. Use only when SAML authentication is intended. | | `IS_JWT_ENABLED` | IS\_JWT\_ENABLED | `boolean` | No | Use only when JWT authentication is intended and provider mapping is configured. | | `JWT_PROVIDERS` | JWT\_PROVIDERS | `string` | No | Provide JWT providers and external identifiers in the format `::`. Separate multiple providers with a comma. Use only when JWT authentication is intended. | For additional attribute descriptions and provisioning behavior, refer to [Default Create Account Attributes](). # Provisioning The SAP HANA connector supports provisioning, allowing you to create and manage accounts and entitlements in SAP HANA 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 | Account Attribute | Generator | Description | | --- | --- | --- | | USER\_NAME | Generator | The name of the user that needs to be created. | | password | Generator | The password of the user. | | FORCE\_PWD\_CHG\_ON\_NEXT\_LOGON | Disable | Enable this attribute if the user must be requested to change their password at the next login. | | IS\_RESTRICTED | Disable | Enable this attribute to create a restricted user. | ### Additional Attributes The SAP HANA Source supports the following additional attributes: | Account Attribute | Generator | Description | | --- | --- | --- | | Disable Password | Static | Sets the password in 'disable' mode. By default, the value is false. | | Email Address | Identity Attribute | The email address. It is mapped to the Work Email of the user. | | Time Zone | Disable | The time zone of the user. | | Valid From | Disable | The date/time from when the user account is valid. | | Valid Until | Disable | The date/time until when the user account is valid. | ### Supported Entitlement Attributes The SAP HANA source supports the following entitlement attributes while creating or updating an account: - CATALOG\_ROLES - REPOSITORY\_ROLES - SYSTEM\_PRIVILEGES - APPLICATION\_PRIVILEGES The SAP HANA source does not aggregate and display as CATALOG\_ROLES. The roles are granted to a user in all the schema in the native HANA system (when the role exists in all the schema), however, it is granted to the user in one schema in the native HANA. ### Force Password Change On Next Logon > [!NOTE] > > **Force Password Change On Next Logon** is set to YES when the service account is used to create an account. **Force Password Change On Next Logon** can be set to NO only when the Admin account is used as the service account for SAP HANA. The Service account must have the privilege **AUDIT ADMIN** to make these changes. - Set the value to **Yes**, if the user must be requested to change their password at next login. - If the **Force Password Change On Next Logon** flag is not specified in the provisioning plan, then the password mode (permanent or temporarily) is dependent on the SAP HANA security policy. - To set the value to **No**, the following configurations must be made on the SAP HANA managed system. 1. Sign in to the SAP HANA studio as the System User. 2. Right-click on **Security** to open the security console. 3. Select the **Password Policy** tab. 4. Uncheck the option for **User must change password at first logon**. ### Kerberos Authentication > [!NOTE] > > Kerberos authentication is not supported when using SAP HANA Cloud database. | Attribute Name | Description | | --- | --- | | IS\_KERBEROS\_ENABLED | Specifies whether Kerberos authentication is enabled for a user as true or false. | | External ID for Kerberos | Specifies the external identifier for Kerberos authentication. | ### SAML Authentication | Attribute Name | Description | | --- | --- | | Identity Provider Name | Specifies the SAML identity provider name. | | External ID for SAML | Specifies the external identifier for SAML authentication. | #### SAML Providers List Use this field to create an account with multiple SAML identity providers for a user. Enter the SAML Provider names along with their external identifiers in the format: `Provider::ExternalIdentifier`. To provide multiple values, separate them with a comma. For example, `SAML_PROVIDER1::XS1,SAML_PROVIDER2::XS1` > [!NOTE] > > If this field is used during the provisioning flow, it will take priority over the `SAML Identity Provider Name` and `External ID`. ### JWT Authentication #### IS\_JWT\_ENABLED Boolean that enables JWT authentication for the user. > [!NOTE] > > If this attribute is set to `true` during Create Account operations, the connector updates the `JWT_USER_MAPPINGS` table with the corresponding `JWT_PROVIDERS` values. If the attribute is set to `false`, the connector doesn't perform any updates to the `JWT_USER_MAPPINGS` table. #### JWT\_PROVIDERS Provide the `JWT_PROVIDERS` attribute value in the following format: Defines the list of JWT providers along with each of the external identifiers each one uses in the following format: `::` If there are multiple providers, separate each one with a comma (`,`). For example: `MY_JWT_PROVIDER1::external1,MY_JWT_PROVIDER2::external2` > [!NOTE] > > During Update operations, `JWT_PROVIDERS` takes precedence before `IS_JWT_ENABLED`. For information on provisioning custom parameters, refer to [Custom User Parameters](). Once you have added the custom parameter to your account schema you can update the parameter value in your provisioning policy. The technical name for the field should be the same as the name of the parameter to be provisioned along with the `PARAM:` prefix (this must be in all capital letters) to mark it as a parameter. > [!NOTE] > > Ensure the attribute name (except the prefix `PARAM:`) matches the case of the parameter name in the database without any unwanted leading or trailing spaces. The SAP HANA connector supports provisioning of only the following attributes: > [!NOTE] > > The SAP HANA connector supports the provisioning of users having Kerberos and SAML 2.0 authentication along with password authentication mechanism. For more information on using Kerberos and SAML 2.0 authentication, refer to [Additional Authentication Resources](). ### Create and Update Operation Only Entitlement Attributes - APPLICATION\_PRIVILEGES - CATALOG\_ROLES - REPOSITORY\_ROLES - SYSTEM\_PRIVILEGES ### Update Operation Account Attributes - EMAIL\_ADDRESS - TIME\_ZONE - VALID\_FROM - VALID\_UNTIL - DISABLE\_PASSWORD - IS\_RESTRICTED - IS\_CLIENT\_CONNECT\_ENABLED - EXTERNAL\_IDENTITY\_KERBEROS - SAML\_PROVIDER - SAML\_PROVIDERS - EXTERNAL\_IDENTITY\_SAML # 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 HANA 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 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 | | --- | --- | | USER\_ID | Account | | ROLE\_ID | Group | | ROLE\_ID | REPOSITORY\_ROLE | ### Default Account Attributes The SAP HANA 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 | | --- | --- | | USER\_ID | The ID of the user. This is an Account ID which must not be changed. | | USER\_NAME | The name of the user. | | USER\_MODE | The mode of the user:
\- LOCAL
\- GLOBAL
\- EXTERNAL | | CREATOR | The creator of the user. | | VALID\_FROM | Specify a date/time from when the user account is valid. | | VALID\_UNTIL | Specify a date/time until when the user account is valid. | | IS\_JWT\_ENABLED | Indicates if JWT authentication is enabled for the user | | IS\_RESTRICTED | Specifies whether the user is a restricted user. | | IS\_CLIENT\_CONNECT\_ENABLED | Specifies whether the user is able to connect to the client. | | JWT\_PROVIDERS | Lists JWT providers with the external identifiers each one uses in the following format:
`::`
If there are multiple providers, separate each one with a comma (`,`).
For example:
`MY_JWT_PROVIDER1::Jon,MY_JWT_PROVIDER1::jon` | | HAS\_REMOTE\_USERS | Specifies whether there is a database user in another tenant database as the remote identity of the database user. | | SESSION\_CLIENT | Specifies the client whose data can be accessed by the user. | | EMAIL\_ADDRESS | The email address of the user. | | TIME\_ZONE | The time zone of the user. | | AUTHENTICATION\_TYPE | The different authentication methods supported by user. | | SYSTEM\_PRIVILEGES | The system privileges assigned to the user. | | APPLICATION\_PRIVILEGES | The application privileges assigned to the user. | | CATALOG\_ROLES | The catalog roles assigned to the user. | | REPOSITORY\_ROLES | The repository roles assigned to the user. | | FORCE\_PWD\_CHG\_ON\_NEXT\_LOGON | Specifies whether the user must change the password on the next logon in the SAP HANA database. | | IS\_KERBEROS\_ENABLED | Specifies whether Kerberos authentication is enabled for user. | | EXTERNAL\_IDENTITY\_KERBEROS | Specifies the external identifier for Kerberos authentication. | | IS\_SAML\_ENABLED | Specifies whether SAML authentication is enabled for user. | | SAML\_PROVIDER | Specifies the SAML identity provider name. | | SAML\_PROVIDERS | Lists all configured SAML Identity Provider names along with their external identifiers in the following format: `Provider::ExternalIdentifier`
This field will be populated if the user has multiple SAML providers available in the SAP HANA database. If there is only one SAML provider configuration available for user, this field will not hold any value. | | EXTERNAL\_IDENTITY\_SAML | Specifies the external identifier for SAML authentication. | ### Custom User Parameters The connector supports aggregating and provisioning custom parameters associated with a database user, available in the `USER_PARAMETERS` table in the SAP HANA database. #### Custom Parameter Aggregation In order to aggregate custom parameters for a database user that exists in the `USER_PARAMETERS` table in the SAP HANA database, you must add the parameter name with the prefix `PARAM:` (this must be in all capital letters) as an attribute in the account schema. For example, to aggregate a parameter named `ADDRESS`, add the `PARAM:ADDRESS` attribute in the account schema. > [!NOTE] > > Ensure the attribute name (except the prefix `PARAM:`) matches the case of the parameter name in the database without any unwanted leading or trailing spaces. ## 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. ### Group Aggregation Configuration The SAP HANA source in SailPoint supports the following group and entitlement objects: | Object | Description | | --- | --- | | REPOSITORY\_ROLE as group object | Supported Operation: Read | | CATALOG\_ROLE as Account Group CATALOG\_ROLE | Supported Operation: Read | | REPOSITORY\_ROLE, SYSTEM\_PRIVILEGE, APPLICATION\_PRIVILEGE and CATALOG\_ROLE as entitlement objects | Supported Operation: Add / Remove entitlement | For the SAP HANA source, only the Repository Roles and Catalog Roles are aggregated after entitlement aggregation. Other supported entitlement types display as Role IDs instead of their display names after the account aggregation. > [!NOTE] > > Some sources may not include Catalog Roles as group entitlements. To support Catalog Roles, you must add the CATALOG\_ROLES schema as a group schema. The following is an example of the JSON payload: ```json { "nativeObjectType": "CATALOG_ROLE", "identityAttribute": "ROLE_ID", "displayAttribute": "ROLE_NAME", "hierarchyAttribute": null, "includePermissions": false, "features": [], "configuration": {}, "attributes": [ { "name": "ROLE_NAME", "type": "STRING", "schema": null, "description": "Role name", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "ROLE_ID", "type": "STRING", "schema": null, "description": "Role ID", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "ROLE_MODE", "type": "STRING", "schema": null, "description": "Mode of the role: 'LOCAL' ", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "GLOBAL_IDENTITY", "type": "STRING", "schema": null, "description": "Identity specified for role with ROLE_MODE GLOBAL ", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "CREATOR", "type": "STRING", "schema": null, "description": "Name of the user who created the role ", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "GRANTED_ROLES", "type": "STRING", "schema": null, "description": "The roles which are assigned to the current role ", "isMulti": true, "isEntitlement": false, "isGroup": false } ], "name": "catalog_roles", "modified": null } ``` # 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]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## An error message was displayed while removing the role assigned to the user ```text Service account does not have permission to revoke ``` **Resolution**: Revoking the role can be achieved by the same user who has granted it. ## Test connection fails with an error message ```text Please enter valid Driver Class ``` **Resolution**: Copy the latest `ngdbc.jar` file in the `\identityiq\WEB-INF\lib` directory. ## An error message is displayed for incorrect value of the VALID\_FROM field ```text SAP DBTech JDBC: [438]: invalid user parameter value: VALID FROM not allowed to be in the past ``` **Resolution**: Enter the value of the VALID\_FROM field as null to create the account with today's date. ## Create Account fails with Invalid Username Error ```text Invalid Username ``` **Resolution**: Double check the USER\_NAME field in the Create Profile section to ensure the username does not have any special characters or spaces. For more information, refer to [HANA User Name Restrictions](). ## Uploaded JAR Uses an Unsupported Java Version **Resolution:** Use a lower version file such as the SAP HANA SPS4 ngdbc.jar ## SAP HANA Aggregation Failure After Database Upgrade After upgrading the SAP HANA on-premise database from HANA 2.0 SP08 Rev 87 to HANA 2.0 SP08 Rev 89, aggregation fails with the following error: ```text Error in aggregation 8473e6294b9648d6a3bf7f31c2f121ec: java.lang.RuntimeException - SAP DBTech JDBC: [260]: invalid column name: USER.INVALID_CONNECT_ATTEMPTS: line 1 col 346 (at pos 345) - java.lang.RuntimeException: SAP DBTech JDBC: [260]: invalid column name: USER.INVALID_CONNECT_ATTEMPTS ``` ```text Exception on iterateObjects for application : SAP HANA SE3 Test1 [source] exception is SAP DBTech JDBC: [260]: invalid column name: CREATOR ``` **Resolution:** Verify that the service account has the required permissions to access all relevant system views and tables. If the issue persists, create a new service account with the appropriate permissions and update the connector configuration accordingly. ## Account Deletion Failure Error: Delete operation does not work. **Resolution**: Set the `endDateOnDelete` key to `false`, and retry the delete operation. ## Public catalog role not removed **Issue**: Public catalog role is not removed in user certification. **Resolution**: Set the `IS_RESTRICTED` key to `true` and remove the public role from the provisioning plan. Set `IS_RESTRICTED`: ```xml true ``` Remove the public role: ```xml ``` ## Incorrect Access Sunset Timing for SAP HANADB Users Due to Time Zone Differences When a role is sunset for SAP HANADB users, the actual expiration time may be incorrect. It might not match the requester's expectations due to how different time zones are processed. **Resolution:** The sunset end date will now respect the requester's local time zone (matching their computer's system time) instead of relying on a fixed server time zone. Examples: `Someone in EST picks end date 10 June → access ends at 12:00 AM on 10 June EST.` `Someone in IST picks the same date 10 June → access ends at 12:00 AM on 10 June IST.` # 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]() and [REST API - Update Source (Partial)]() 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" } ] ```