# SailPoint Mainframe Top Secret LDAP Connector Documentation > Mainframe Top Secret LDAP Connector Documentation # Documentation # Configuring Top Secret LDAP for Integration Configure the following features for the Top Secret LDAP connector: ## TLS Communication Between SailPoint and Top Secret LDAP Server Enable TLS communications between SailPoint and Top Secret LDAP Server to provide the most secure connection. > [!NOTE] > > Install the certificate into the JVM keystore for a Java client to connect using TLS and self-signed certificates. ### System Requirements The following components for z/OS versions must be installed for TLS communication: | z/OS Version | Cryptographic Services | z/OS Security Level 3 | | --- | --- | --- | | z/OS 2.4 | System SSL Base: FMID HCPT440 | System SSL Security Level: FMID JCPT441 | | z/OS 2.5 | System SSL Base: FMID HCPT450 | System SSL Security Level: FMID JCPT451 | | z/OS 3.1 | System SSL Base: FMID HCPT510 | System SSL Security Level: FMID JCPT511 | ## TLS Configuration on Virtual Appliances Transport Layer Security (TLS) is recommended for encrypted communication between virtual appliances (VAs) and sources that support it. To enable TLS for a supported source: 1. In your tenant, go to **Admin \> Connections \> Sources**, and select your supported source. 2. In the **Source Setup** section, select **Use Transport Layer Security (TLS)** on the relevant config pages. 3. Select **Save**. The TLS certificate should be automatically copied to the VA cluster associated with the source. For example, Active Directory sources include checkboxes to enable TLS support in the following source configuration settings: - Forest - Domain - IQ Service - Exchange For more information about TLS configuration and manually adding certificates to VAs, refer to [TLS Configuration on Virtual Appliances](). ### Manually Uploading a Certificate to a Virtual Appliance This section describes the procedure for importing a certificate and keychain to the virtual appliance. #### Importing a Certificate and Keychain to the Virtual Appliance When adding a certificate to the virtual appliance, ensure that: - You must complete the following steps for every virtual appliance on the virtual appliance cluster that is connected to the source. - To manually add a new certificate for the source to your virtual appliance's truststore, you need to ensure that the virtual appliance does not connect to the source before you complete the steps listed here. Do not test the connection between the source and virtual appliance. This also might require temporarily suspending scheduled aggregations. - The source server has been configured for TLS. - The `va-config-.yaml` file has been configured for your virtual appliance. > **Note** > > The certificate you copy must use PEM format. > **Note** > > For information on creating a hosts.yaml file, refer to [Configuring a Hosts.yaml File](). Perform the following steps: 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 imports from the source. 2. Restart the Connector Gateway using the following command: ```text sudo systemctl restart ccg ``` 3. Watch the `/home/sailpoint/log/ccg-start.log`. If this is successful, the import should log messages of the following 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 that a PEM format is used for your certificate and try again. > - Sometimes export of a certificate may not work properly with the virtual appliance. Using the `openssl` command to get the certificate is a good way to get the latest certificate: > > 1. Run the following command: > > ```text > openssl s_client -connect server.example.com:636 > output < /dev/null > ``` > 2. From the command output, the top of the output file has the certificate. It starts with `--BEGIN CERTIFICATE--`. Copy the contents between that and `--END CERTIFICATE--`. > 3. Create a new file in the `/home/sailpoint/certificates` directory called `cert.pem` with the contents you copied. > 4. Restart the Connector Gateway using the `sudo systemctl restart ccg` command. ### Using an External Certificate Authority (CA) If you are 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 to 1.2 - You have created at least one virtual appliance cluster - CA root and intermediate certificates are in the Java CA certificates keystore - The certificate is on the source Perform 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 using Active Directory with IQService enabled, the Hostname cannot be an IP Address. 2. Change the **Port** to 636. 3. If available, enable the **Use TLS** option. 4. Test the connection. The source's certificate is auto-imported to the VA. #### Replace an Expired Certificate Issued by an External CA When your certificate has expired, you can replace it on the source and then reboot your VA. **Prerequisites** Complete the process as described in [Adding the Certificate to the Virtual Appliance](<#adding-the-certificate-to-the-virtual-appliance>). Perform the following steps: 1. Add the new certificate on the source with a new name. 2. Restart the Connector Gateway using the following command: ```text sudo systemctl restart ccg ``` The source's certificate is auto-imported to the VA. ### Using an Internal Certificate Authority (CA) Configure an internal certificate authority on the virtual appliance. #### Adding the Certificate to the Virtual Appliance If you are using your own certificate authority, you 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 Perform the following steps: 1. Import the certificate and entire key chain (Root and Intermediate Certificates) to the VA as described in [Importing a Certificate and Keychain to the Virtual Appliance](<#importing-a-certificate-and-keychain-to-the-virtual-appliance>). 2. Restart the Connector Gateway using the following command: ```text 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 using Active Directory with IQService enabled, the Hostname cannot be an IP Address. 4. Change the **Port** to 636. 5. If available, enable the **Use TLS** option. 6. Test the connection. The source's certificate is auto-imported to the VA. #### Replace an Expired Certificate When your certificate has expired, you need to add the new certificate on both the source and the VA with a new name. **Prerequisites** Complete the process described in [Adding the Certificate to the Virtual Appliance](<#adding-the-certificate-to-the-virtual-appliance>). Perform the following steps: 1. Add the new certificate on the source with a new name. 2. Import the certificate and entire key chain (Root and Intermediate Certificates) to VA as described in [Importing a Certificate and Keychain to the Virtual Appliance](<#importing-a-certificate-and-keychain-to-the-virtual-appliance>). 3. Restart the Connector Gateway using the following command: ```text sudo systemctl restart ccg ``` 4. Test the connection. The source's certificate is auto-imported to the VA. #### TLS Configuration Without DNS If DNS is not configured for your network, you need to edit the `hosts.yaml` file on the virtual appliance to specify the hostname. This is because the sources that support TLS communication use IQService which cannot connect to TLS over an IP address. > [!NOTE] > > By default, the virtual appliance obtains the TLS certificate automatically from the source the first time it connects to the source. If you want to manually load the certificate to your virtual appliances, you need to do so before the source successfully connects to the virtual appliance. **Prerequisites** At least one virtual appliance cluster has been configured and connected successfully. > [!NOTE] > > **Best Practice** > > The instructions contained in this section are most effective when executed as a virtual appliance is being created, before configuring the `proxy.yaml` file. For more information, refer to the [Virtual Appliance Reference Guide](). Perform the following steps: 1. Open your virtualization platform and start the VA. 2. Sign in to the virtual appliance. > **Screenshot** > > [![Virtual appliance hosts.yaml file]()]() 3. Open the `hosts.yaml` file to edit it. 4. Uncomment lines 3-6 and replace 4-6 with actual values, according to the following requirements: > **Screenshot** > > [![Edited virtual appliance hosts.yaml file]()]() - The spacing and indentation must be precise. - The fourth line must start with 2 spaces followed by a valid IP address matching the IP address configured for the host. - The fifth line must start with 2 spaces followed by a dash and 1 additional space. It must contain a fully-qualified hostname. - The sixth line must start with 2 spaces followed by a dash and 1 additional space. It must contain a hostname, and must match the hostname configured for the source. Both are required. > **Note** > > If you have IQService configured for your source, you cannot use an IP address for a hostname. 5. Repeat the previous step as needed for multiple entries. 6. Copy the `hosts.yaml` file to the VM, using SCP, as follows: 1. Find the IP address for the VA by running `ifconfig -a`. 2. Copy the file by running the SCP command on your local workstation, as follows: ```text scp /hosts.yaml sailpoint@:/home/sailpoint/hosts.yaml ``` > **Note** > > If you want to manually upload a TLS certificate to your VA, do so now. Refer to [Manually Uploading a Certificate to a Virtual Appliance](<#manually-uploading-a-certificate-to-a-virtual-appliance>) for instructions. 7. Choose one of the following: - If you are editing an existing virtual appliance, continue to the next step. - If you are configuring a new virtual appliance, continue configuring the virtual appliance using the [Virtual Appliance Reference Guide](). 8. Enable TLS for the source. # Connecting SailPoint and Mainframe Top Secret LDAP To connect SailPoint with Top Secret LDAP, 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**. ## Connection Settings Configure a secure, direct connection to the Top Secret LDAP source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. In the **Service Account** field, enter a DN. The DN should point to a user in the LDAP tree with permissions to manage the Top Secret LDAP server. For example: ```text cn=Admin ``` 2. In the **Password** field, enter the password for the Service Account. 3. In the **Hostname or IP Address** field, enter the host name or the IP address of the server where LDAP is installed. 4. In the **Port** field, enter the port number that the server communicates through. 5. Enable the **Use TLS** option if the connection is over TLS. For more information, refer to [TLS Configuration on Virtual Appliances](). > **Note** > > The certificate used must have the FQDN of server machine as the subject under CN. 6. Enable the **Disable Hostname Verification** option to disable the hostname verification during LDAP Communication over TLS. 7. Select **Save**. ## Aggregation Settings Configure the settings to aggregate accounts from Top Secret LDAP system. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. In the **Search DN** field, enter the distinguished name of the container used to aggregate the accounts. 2. Enter the **LDAP Search Filter** that defines the scope for accounts aggregated from the configured container. 3. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with Mainframe Top Secret LDAP The Top Secret LDAP Mainframe connector mainly uses LDAP interfaces to communicate with the CA LDAP server. The Top Secret LDAP Mainframe connector supports the capability to read and provision Top Secret LDAP users and entitlements. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Top Secret LDAP connector supports the following features: - Load accounts from Top Secret LDAP - \*Provision Top Secret LDAP Accounts - \*Access Certifications (certification of entitlements connected to accounts) - \*Password management For more information on features, refer to [Source Features](). > [!NOTE] > > Before you can use any item above marked with an asterisk (\*), SailPoint must activate the feature for your site. ### 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](). ## Supported Managed Systems The Top Secret LDAP Mainframe connector supports the following managed system: - CA LDAP Server for z/OS Release 15.1.00 with CATSS\_UTF back end ## Prerequisites - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Install and configure CA LDAP Server for z/OS. - Create a service account on Top Secret LDAP with the required permissions. ## Required Permissions The service account configured for the Top Secret LDAP Mainframe source must have read/write privileges over the Top Secret directory information tree to manage the Top Secret data. # Provisioning The Mainframe Top Secret LDAP connector supports provisioning, allowing you to create and manage accounts and entitlements in Top Secret LDAP 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 The following table lists the Create Profile provisioning policy attributes: | Account Attribute | Description | | --- | --- | | dn | Create Unique Account ID. This generator uses the value in the **Pattern Used** field to generate a unique DN for the new account. | | Password | Create Password generator. The password of the user to be created. | | NAME | Display name. The display name of the user to be created. | | DEPT | The department identity for the users. Static value. | | Facilities | The facilities to which a user has access. Static value. | | TSOLPROC | Used to provide a default procedure to be used for TSO logon. The one- to eight-character logon procedure name. Procedure names are also TSO-related resources and the user must be permitted to any procedure name with which they attempt to log on. Static value. | | CONSOLE | Used to grant or remove an ACID's ability to modify control options. For VM, options are modified through the TSS MODIFY command only. With VSE and OS/390, options are modified at the O/S console or through the TSS MODIFY command function. Static value. | # 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 Mainframe Top Secret LDAP connector uses the following default correlation and object configurations. This Integration Module supports three types of objects: Account, TopSecretProfile, and TopSecretGroup. ## 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 | | --- | --- | | dn | Account | | dn | TopSecretProfile | | dn | TopSecretGroup | ### Default Account Attributes The Mainframe Top Secret LDAP connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. The following table lists the account attributes: | Attribute Name | Description | | --- | --- | | dn | Distinguished name of the Top Secret User. | | ACCESSORID | Top Secret User ID. | | objectClass | Top Secret User Object Classes. | | AACID | Authority levels at which ACID can manage ACIDs within scope. | | AdminListData | Authority to list Security File information. | | Misc1 | Authority to perform one or more administrative functions (LCF, INSTDATA, USER, LTIME, SUSPEND, NOATS, RDT, TSSSIM, ALL). | | Misc2 | Authority to perform one or more administrative functions (ALL, SMS, TSO, NDT, DLF, APPCLU, WORKATTR, TARGET). | | Misc3 | Authority to perform one or more administrative functions (ALL, SDT, PTOK). | | Misc8 | Authority to list the contents of the RDT, FDT or STC or to use the ASUSPEND administrative function (LISTRDT, LISTSTC, LISTAPLU, LISTSDT, MCS, NOMVSDF, PWMAINT, REMASUSP, ALL). | | Misc9 | Authority to perform one or more high-level administrative functions (BYPASS, TRACE, CONSOLE, MASTFAC, MODE, STC, GLOBAL, GENERIC, ALL). | | ASUSPEND | Account is suspended due to administrator action. | | NODSNCHK | CA Top Secret bypasses all data set access security checks for this ACID. | | SITRAN | CICS transaction CA Top Secret automatically executes after an ACID successfully signs on to a facility. | | OPCLASS | CICS operator classes. | | OPIDENT | CICS operator identification value equal to the ACID OPIDENT entry in the CICS SNT (Signon Table). | | OPPRTY | CICS operator priority of associated ACID. | | SCTYKEY | CICS security keys an ACID may use. | | CONSOLE | Ability to modify control options by ACID. | | CREATED | Date ACID was created. | | DEPT | Department ACID. | | DIVISION | Division ACID. | | EXPIRE | Expiration date of ACID. | | GROUPS | List of groups a TSS user is a member. | | XSUSPEND | Account is suspended due to Top Secret Installation exit. | | LAST-COUNT | Number of times the ACID has been used (logon times since user was defined). | | MASTFAC | Multi-user facility name. | | MCSAUTH | Authorize the operator commands that can be entered from the console. | | PROFILES | List of profiles a Top Secret user is a member. | | MODIFIED | Last date and time when ACID was updated. | | NAME | Name of ACID. | | NOPWCHG | Prevent ACID from changing passwords at signon or initiation. | | OIDCARD | Prompt ACID to insert identification cards into a batch reader whenever signing on to TSO. | | DFLTGRP | Default group to an ACID operating under OpenEdition MVS. | | HOME | Subdirectory of ACID under OMVS. | | UID | Numeric UID value for security within USS. | | PSUSPEND | Account is suspended due to password violation. | | PHYSKEY | Physical security key to support external authentication devices. | | TSOHCLASS | Default hold class for TSO-generated JCL for TSO users. | | TSOJCLASS | Job class for TSO generated job cards from TSO users. | | TSOLACCT | TSO default account number. | | TSOCOMMAND | Default command issued at TSO logon. | | TSOLPROC | Default procedure used for TSO logon. | | TSOMSIZE | Maximum region size (in kilobytes) that a TSO user may specify at logon. | | TSOMCLASS | Default message class for TSO generated JCL for TSO users. | | TSOMPW | Support multiple TSO UADS passwords, on a user-by-user basis. | | TSOOPT | Default options that a TSO user may specify at logon. | | TSODEST | Default destination identifier for TSO generated JCL for TSO users. | | TSODEFPRFG | Default TSO performance group. | | TSOLSIZE | Default region size (in kilobytes) for TSO. | | TSOSCLASS | Default SYSOUT class for TSO generated JCL for TSO users. | | TSOUNIT | Default unit name for dynamic allocations under TSO. | | TSOUDATA | Site-defined data field to a TSO user. | | USER | User defined classes and resources. | | PASSEXPD | Expiration date of password. | | PASSINTV | Number of days during which password remains valid. | | TYPE | ACID type (MSCA, LSCA, SCA, ZCA, VCA, MCA, USER). | | VSUSPEND | Account is suspended due to access violation. | | ZONE | Zone ACID. | ## 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. ### TopSecretProfile Attributes Object Type: TopSecretProfile The following table lists the profile attributes: | Attribute Name | Description | | --- | --- | | dn | Distinguished name of Top Secret Profile. | | ACCESSORID | Top Secret Profile ID. | | objectClass | Top Secret Profile Object Classes. | | AUDIT | Allow an audit of ACID activity. | | CREATED | Date ACID was created. | | DEPT | DEPT ACID. | | DIVISION | Division ACID. | | GAP | Globally administered profile. | | MODIFIED | Last date and time when ACID was updated. | | NAME | Name of ACID. | | NOPWCHG | Prevent ACID from changing passwords at signon or initiation. | | OIDCARD | Prompt ACID to insert identification cards into a batch reader whenever signing on to TSO. | | GID | Group identification for OMVS. | | SOURCE | Source reader or terminal prefixes through which the associated ACID may enter the system. | | LTIME | How long (in minutes) until terminal of ACID locks if CA Top Secret does not detect activity at that terminal. | | TYPE | ACID type. | | ZONE | Zone ACID. | ### TopSecretGroup Attributes Object Type: TopSecretGroup The following table lists the group attributes: | Attribute Name | Description | | --- | --- | | dn | Distinguished name of Top Secret Profile. | | ACCESSORID | Top Secret Group ID. | | objectClass | Top Secret Group Object Classes. | | AUDIT | Allow an audit of ACID activity. | | CREATED | Date ACID was created. | | DEPT | DEPT ACID. | | DIVISION | Division ACID. | | GAP | Globally administered profile. | | MODIFIED | Last date and time when ACID was updated. | | NAME | Name of ACID. | | NOPWCHG | Prevent ACID from changing passwords at signon or initiation. | | OIDCARD | Prompt ACID to insert identification cards into a batch reader whenever signing on to TSO. | | GID | Group identification for OMVS. | | SOURCE | Source reader or terminal prefixes through which the associated ACID may enter the system. | | LTIME | How long (in minutes) until terminal of ACID locks if CA Top Secret does not detect activity at that terminal. | | TYPE | ACID type. | | ZONE | Zone ACID. | # 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]() # 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" } ] ```