# SailPoint IBM i Connector Documentation > IBM i Connector Documentation # Documentation # Connecting SailPoint and IBM i To connect SailPoint with IBM i, 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. Select **Virtual Appliance**. A virtual appliance is a Linux-based virtual machine that connects to your sources and apps using SailPoint APIs, connectors, and integrations. For more information about configuring and deploying virtual appliances, refer to [SailPoint Virtual Appliances](). 4. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 5. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 6. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. Under **Connection Type**, select **Direct Connection** or **Flat File**. - **Direct Connection** - A direct connection fetches data from the **Virtual Appliance Cluster** you choose as the application connector for the source. A direct connection configuration allows for real-time updates. For more information about configuring and deploying virtual appliances, refer to the [Virtual Appliance Reference Guide](). - **Flat File** - Select the flat file if no connector is available, or if another system restricts the connection. This option allows only reading and aggregating data as a generic/delimited application. Provisioning activity is unsupported, and additional configuration pages like connection settings and aggregation settings are unavailable. 5. If you selected **Direct Connection**, in **Virtual Appliance Cluster**, select the virtual appliance cluster that will be used as the application connector for the source. 6. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 7. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 8. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. In the **Virtual Appliance Cluster** dropdown list, select the virtual appliance to use when communicating with your organization's systems. For more information, refer to [SailPoint Virtual Appliances](). 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**. ## Connection Settings Provide the information required to connect and interact with the source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() To configure connection settings, complete the following: 1. Enter the **Server Host** IP address for the IBM i Host. 2. Enter the **User Profile** that works for get and set operations on IBM i Host. 3. Enter the **Password** for the user profile. 4. (Optional) Select the **Use TLS** checkbox if the connection is over TLS. For more information, refer to [TLS Configuration on Virtual Appliances](). 5. (Optional) Enter the **Proxy Server** host and port details used to connect to the IBM i Host. Use the format `:` 6. Select **Save**. ## Aggregation Settings Provide the settings for your aggregation. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() [![Aggregation Settings]()]() To configure your aggregation, complete the following: 1. Select an **Aggregation Profile Type** to conduct the aggregation operation on. The available options are **USER**, **GROUP**, and **ALL**. The default is **USER**. 2. Select **Enable Partition** if you want the system to partition the aggregation data. When this is turned off, you see a black X. If it is turned on, you see a blue ✔. 3. Enter the number of **Partition Thread Count** you want the system to subdivide the aggregation data. This overrides the system suggested number of partitions. The default is 2. > **Note** > > If the Virtual Appliance (VA) has a configuration for multiple CPU cores, then it can be configured for a higher number of partition threads to improve performance. 4. Enter the **Partition Statements** to specify the expression to be aggregated. If you need to specify multiple statements, press the **Enter** key after adding each value. Each statement can be an expression, and user profiles matching the specific name are retrieved. For example, if A\*, D\*, and AB\* are entered, then all user profiles starting with A, D, and AB are returned. 5. Select **Save**. ### Aggregation of User Profile Creation Date Time The IBM i connector supports aggregating User Profile Creation Date Time (UPCRTD). To aggregate the `UPCRTD` attribute, you must add it manually, in the account schema. For more information, refer to [Editing an Account Schema](). ## 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. # Integrating SailPoint with IBM i This document is designed to give specific information about the requirements and field definitions needed to get a working instance of an IBM i connector 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 IBM i connector supports the following features: ### Account Management > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. - Aggregation, Partitioning Aggregation - \*Provision IBM i Accounts - Enable and Disable - Create, Update, Delete - \*Password Management - \*Access Certifications (certifications of entitlements connected to accounts) - Additional Entitlements (Authorization Lists) ### Entitlement Management - Aggregation ### Permissions Management > [!NOTE] > > For more information on Permissions Management, refer to [Configure Direct Permissions](<#configure-direct-permissions>). - Reads direct permissions assigned to user profiles for different resources on the IBM i managed system during accounts and group aggregations, respectively. - Delete Accounts - Revokes account direct permissions through certifications. For more information on features, refer to [Source Features](). ### Authorization List The IBM i connector reads the authorization list assigned to accounts and groups as an AUTL attribute during account and entitlement aggregation, respectively. The IBM i connector supports: - Aggregating Authorization Lists associated with users. - Aggregating Authorization Lists associated with groups. - ADD/Remove Authorization Lists. > [!NOTE] > > USER DEFINED authority (authority other than ALL, CHANGE, or EXCLUDE) in the authorization list is not supported for provisioning operations. If a user tries to add or remove an authorization list having USER DEFINED authority, then the connector displays the following error: > > ```text > AUT(USER DEFINED) USER DEFINED is not a valid parameter > ``` > > For example, if a user tries to add an authorization list having user defined authority, the following error message is displayed: > > ```text > Failed to execute Command: ADDAUTLE USER() AUTL() AUT(USER DEFINED) USER DEFINED is not a valid parameter > ``` ## Supported Managed Systems The IBM i connector supports the following versions of IBM i: - IBM i 7.5 - IBM i 7.4 - IBM i 7.3 ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the [Virtual Appliance Reference Guide](). - The administrator account used in Connection Credentials needs to have the required permissions. - To connect with the IBM i system and access the data and services, the connector uses IBM Toolbox for Java (JTOpen). JTOpen requires installation and configuration of the following components on the IBM i system: - TC1 Licensed Program (TCP/IP Connectivity Utilities) - Host Server option of IBM i The IBM i connector utilizes the following services running on the remote port: | Service Name | Port | SSL Port | | --- | --- | --- | | as-signon | 8476 | 9476 | | as-rmtcmd | 8475 | 9475 | | as-svrmap | 449 | NA | ## Required Permissions The IBM i connector requires security officer/user profile with the required permission to accomplish provisioning tasks. The administrator that is configured for the IBM i connector must be assigned sufficient privileges on the IBM i connector to create and update user profiles and group profiles. For example, the user profile can be configured as an administrator with any one of the following user classes and special authorities, as mentioned in the following table: > [!NOTE] > > Depending on the system security level (QSECURITY), the special authorities assigned to the user differ. Ensure that the created user profiles have the special authorities. | USER CLASS (USRCLS) | SPECIAL AUTHORITY (SPCAUT) | | --- | --- | | \*USER (user) | \*SECADM, \*AUDIT, \*ALLOBJ | | \*SECADM (security administrator) | \*SECADM, \*AUDIT, \*ALLOBJ | | \*SECOFR (security officer) | \*NONE | | \*SYSOPR (system operator) | \*SECADM, \*AUDIT, \*ALLOBJ | > [!NOTE] > > For configuration of a user profile as an administrator, you can specify different options of user class and special authority in various ways in accordance with your requirements. The table displays a few examples of the different ways in which you can configure the administrator. ### Configure Direct Permissions The `directPermissionObjectType` configuration attribute contains list of various object types owned by the user. By default, the following direct permission object types are configured (you can change this list, as required): - `*LIB` - `*MSGQ` - `*FILE` - `*PGM` - `*CMD` - `*MENU` - `*AUTL` - `*JOBQ` > [!IMPORTANT] > > Enabling direct permissions increases the aggregation time. You must correctly select and configure the direct permission object types. The supported objects can be added or removed using REST API. For example, if the list has only the following object types, then these objects are aggregated as direct permission object types: - `*LIB` - `*MSGQ` By default, the aggregation of direct permissions is not enabled. Perform the following steps to enable direct permissions and their aggregation, for the account or the group schema of your IBM i connector: > [!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. 1. Use the [listSources]() API to get the source ID. 2. Use the [listSchemas]() API to get schema ID for the account or group schema for which you want to enable direct permissions. 3. Use the [updateSchema]() API and enter the following content in body, with the `sourceID` and the `schemaID` in the header. ```json { "op": "replace", "path": "/includePermissions", "value": true } ``` # 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. > [!NOTE] > > Attributes marked with an asterisk (\*) are mandatory. ## Machine Account Provisioning Attributes | Create Account Attribute | Description | | --- | --- | | USRPRF\* | The user profile name for the account. | | GRPPRF\* | The group profile name for the account. | # Provisioning The IBM i connector supports provisioning, allowing you to create and manage accounts and entitlements in IBM i 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 | | --- | --- | --- | | USRPRF | Create Unique Account ID | The User profile. This generator uses the value in the **Pattern Used** field to generate a unique DN for the new account.
**Caution:** You must change the OU in the **Pattern Used field** in the `distinguishedName` attribute. | | GRPPRF | Static | The profile of the group used. | | UID | Disable | The identity of the user. | | USRCLS | Disable | The user class. | | password | Create Password | This generator creates an initial password for the new account that matches the password policy assigned to the associated IBM i source in SailPoint. | | PWDEXP | Disable | Expiration of the password that you set up. | # 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 IBM i 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 | | --- | --- | | USRPRF | Account | | USRPRF | Group | ### Default Account Attributes The IBM i connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. The following lists the account and account - group attributes: | Attribute Name | Description | | --- | --- | | USRPRF | User profile. | | PWDEXP | Set password to expired. | | STATUS | Current user status. | | USRCLS | User class. | | ASTLVL | Assistance level. | | CURLIB | Current library. | | INLPGM | Initial program to call. | | INLMNU | Initial menu. | | LMTCPB | Limit capabilities. | | TEXT | Text description. | | SPCAUT | Special authority. | | SPCENV | Special environment. | | DSPSGNINF | Display sign-on information. | | PWDEXPITV | Password expiration interval. | | LCLPWDMGT | Local password management. | | LMTDEVSSN | Limit device sessions. | | KBDBUF | Keyboard buffering. | | MAXSTG | Maximum allowed storage. | | PTYLMT | Highest schedule priority. | | JOBD | Job description. | | GRPPRF | Group profile. | | OWNER | Owner. | | GRPAUT | Group authority. | | GRPAUTTYP | Group authority type. | | SUPGRPPRF | Supplemental groups. | | ACGCDE | Accounting code. | | OBJAUD | Object Auditing. | | MSGQ | Message queue. | | DLVRY | Delivery. | | SEV | Severity code filter. | | PRTDEV | Print device. | | OUTQ | Output queue. | | ATNPGM | Attention program. | | SRTSEQ | Sort sequence. | | LANGID | Language ID. | | CNTRYID | Country or Region ID. | | CCSID | Coded character set ID. | | CHRIDCTL | Character Identifier control. | | SETOBJATTR | Local job attributes. | | LOCALE | Locale. | | USROPT | User options. | | UID | User ID number. | | GID | Group ID number (Only for Groups). | | HOMEDIR | Home directory. | | AUDLVL | Audit Level. | | AUTL | Authorization Lists | | PWDLASTCHG | Date and time when the sign on password was changed. | | PREVSIGNON | Date and time of previous sign on. | | PWDEXPDATE | Date when password will expire. | | INVSIGNON | Number of unsuccessful sign on attempts. | | USREXPACT | User Expiration Action. | | USREXPDATE | User Expiration Date. | | USREXPITV | User Expiration Interval. | | LSTUSEDATE | Last Used Date. | | CHGDATE | Date and time of the last change to the user profile. | | CTRBYUSER | Created by user. | > [!NOTE] > > The `PREVSIGNON` attribute value will now align with day light saving time settings. ### Include Permissions in Account Schema When permissions are aggregated (For example, when `includePermissions="true"` is set to true in the account schema definition and the `privilege` attribute is included in the account schema), the permissions are aggregated under the `directPermissions` attribute, not the `privilege` attribute itself. This data is not visible in the UI but is included in the link or identity XML/JSON. # TLS Configuration on Virtual Appliances Enabling a source to communicate with a virtual appliance using a TLS connection encrypts all data sent between the source and the VA. ## Sources That Support TLS The following sources can be configured to communicate over a TLS connection: - [Active Directory]() - [ACF2]() - [Top Secret]() - [IBM i]() - [OpenLDAP]() - [Oracle Internet Directory]() - [RSA]() - [RACF]() ## Manually Uploading a Certificate to a Virtual Appliance ### Import a Certificate and Keychain to the Virtual Appliance > [!IMPORTANT] > > When adding a certificate to the virtual appliance (VA), ensure that the certificate you copy is in Privacy-Enhanced Mail (PEM) format. - Before manually adding a new certificate for the source to your virtual appliance's truststore, ensure the following: - The virtual appliance (VA) is not connected to the source. - Connection testing between the source and VA is suspended. - Scheduled aggregations are temporarily paused, if necessary. - The source server has been configured for TLS. - The `va-config-.yaml` file has been configured for your virtual appliance. - You must complete the following steps for every virtual appliance on the virtual appliance cluster connected to the source: 1. Copy the PEM-encoded certificates to the `/home/sailpoint/certificates` directory. This directory might not be empty because it's where the VA adds any certificates it gets from the source. 2. Restart the CCG using the following command: `sudo systemctl restart ccg` 3. Watch the `/home/sailpoint/log/ccg-start.log` file. If successful, the import should log messages from the form: ```text {"@timestamp":"2017-04-21 06:57:12 +0000","level":"INFO","type":"ccg","message":"Checking CCG Sources certificates"} {"@timestamp":"2017-04-21 06:57:12 +0000","level":"INFO","type":"ccg","message":"Cert files found: [\"/home/sailpoint/certificates/411818.pem\"]"} 06:57:12 +0000","level":"INFO","type":"ccg","message":"Importing cert /home/sailpoint/certificates/411818.pem"} ``` > **Note** > > If you see an error instead of the log messages above, this is an indication that your certificate is in an invalid format. Verify you're using a PEM format for your certificate and then try again. - Sometimes the export of a certificate may not work properly with the VA. Using the openSSL command to get the certificate is a good way to get the latest certificate. 1. Use the openSSL command to get the latest certificate: 1. Run the following command in openSSL: `openssl s_client -connect server.example.com:636 > output < /dev/null` 2. From the command output file, copy the certificate content between `--BEGIN CERTIFICATE--` and `--END CERTIFICATE--`. 3. Create a new file called `cert.pem` in the `/home/sailpoint/certificates` folder. 4. Save the copied certificate contents in the new `cert.pem` file. 2. Restart the CCG using the following command: `sudo systemctl restart ccg` ## Using an External Certificate Authority (CA) ### Add the Certificate to the Virtual Appliance If you're using an external certificate authority, you only have to connect to the VA from the source to import the certificate. **Prerequisites:** - The ability to use TLS 1.0 - 1.2 - You have created at least one virtual appliance cluster - CA root and intermediate certificates are in the Java CAcerts keystore - The certificate is on the source **Complete the following steps:** 1. In the source, ensure that the following are true: - The **Hostname** for the source matches the hostname in the virtual appliance's configuration. - The source is connected to the virtual appliance you configured to use TLS. > **Note** > > If you are using Active Directory with IQService enabled, the Hostname cannot be an IP Address. 2. Change the **Port** to **636**. > **Screenshot** > > [![Change the port to 636]()]() 3. If available, select the **Advanced Options** checkbox. 4. In the **Use TLS** field, select the **Enable** checkbox. > **Screenshot** > > [![Enable Use TLS]()]() 5. Test the connection. > **Note** > > The source's certificate is auto-imported to the VA. ### Replace an Expired Certificate Issued by an External Certificate Authority When your certificate has expired, replace it on the source and then reboot your VA. **Prerequisites** - Complete the process described in [Add the Certificate to the Virtual Appliance](<#add-the-certificate-to-the-virtual-appliance>). **Complete the following steps:** 1. Add the new certificate on the source with a new name. 2. Restart the CCG using the following command: `sudo systemctl restart ccg` > [!NOTE] > > The source's certificate is auto-imported to the VA. ## Using an Internal Certificate Authority ### Add the Certificate to the Virtual Appliance If you're using your own certificate authority, you will need to add the root and intermediate certificates to the VA. > [!NOTE] > > This process might also be required if your source is not automatically uploading the certificate from the VA. **Prerequisites:** - You have created at least one virtual appliance cluster - The certificate is on the source **Complete the following steps:** 1. Import the certificate and the entire key chain (Root and Intermediate Certificates) to the VA as described in [Import a Certificate and Keychain to the Virtual Appliance](<#import-a-certificate-and-keychain-to-the-virtual-appliance>). 2. Restart the CCG using the following command: `sudo systemctl restart ccg` 3. In the source, ensure that the following are true: - The **Hostname** for the source matches the hostname in the virtual appliance's configuration. - The source is connected to the virtual appliance you configured to use TLS. > **Note** > > If you are using Active Directory with IQService enabled, the Hostname cannot be an IP Address. 4. Change the **Port** to **636**. > **Screenshot** > > [![Change the port to 636]()]() 5. If available, select the **Advanced Options** checkbox. 6. In the **Use TLS** field, select the **Enable** checkbox. > **Screenshot** > > [![Enable Use TLS]()]() 7. Test the connection. > [!NOTE] > > The source's certificate is auto-imported to the VA. ### Replace an Expired Certificate Issued by an Internal Certificate Authority If you're using an internal CA, you need to add the new certificate on both the source and the VA with a new name. **Prerequisites:** - Complete the process described in [Add the Certificate to the Virtual Appliance](<#add-the-certificate-to-the-virtual-appliance_1>) **Complete the following steps:** 1. Add the new certificate on the source with a new name. 2. Import certificate and entire key chain (Root and Intermediate Certificates) to VA as described in [Import a Certificate and Keychain to the Virtual Appliance](<#import-a-certificate-and-keychain-to-the-virtual-appliance>). 3. Restart the CCG using the following command: `sudo systemctl restart ccg` 4. Test the connection. # 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]() ## Group profile (GRPPRF) is not removed from the user record and request fails with an error The system displays the following error: ```text Value for SUPGRPPRF parameter is not correct ``` **Resolution**: To remove GRPPRF from the user record, ensure that no SUPGRPPRF is attached to the same user by completing the following: 1. De-provision SUPGRPPRF first and then GRPPRF for the user. 2. De-provision SUPGRPPRF and GRPPRF in same request. ## Tracing the java calls made by the JTOpen library can be turned on by setting the following JAVA arguments ```text Dcom.ibm.as400.access.Trace.category=error,warning,diagnostic Dcom.ibm.as400.access.Trace.file=/tmp/ibmtoolboxtrace.log ``` ## Account aggregation processes skips some accounts without an error message After an aggregation process, you may notice that some accounts aren't aggregated. The connector does not return any error messages to suggest that anything is wrong. **Resolution**: Enable the `includeUserInfo` parameter via the SailPoint REST API. ```text PATCH https://{orgName}.api.identitynow.com/v3/sources/:id ``` ```json [ { "op": "add", "path": "/connectorAttributes/includeUserInfo", "value": "ALL" } ] ``` > [!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. # 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" } ] ```