# SailPoint Slack Connector Documentation > Slack Connector Documentation # Documentation # Connecting SailPoint and Slack To connect SailPoint with Slack, 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 The following information is required for SailPoint to connect and interact with Slack. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Select **Connection Settings** from the menu. 2. In the **API URL** field, enter the host URL for SCIM API. For example, you can use [https://api.slack.com/scim/v1](). 3. In the **API Token** field, enter the access token that is used for Slack authentication. 4. Select **Save**. ## Aggregation Settings For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Select **Aggregation Settings** from the menu. 2. In **Filter Condition for Accounts**, set up optional conditions to filter accounts during aggregation. For example, `userName Eq "John"` retrieves only those records whose userName is identical to John. `userName co "DM"` retrieves only those records whose userName contains DM. 3. In **Filter Condition for Groups**, set up optional conditions to filter groups during aggregation. For example, `displayName sw "S"` retrieves only those groups whose display name starts with "S". 4. In **Page Size** enter the number of records to fetch in one request. The minimum value is 1 and the maximum value is 1000. By default, the page size is 200. 5. Enable **Manage Channels** to use the channel management feature for new Slack sources. Only the public and active channels present in the workspace will be aggregated. > **Caution** > > Configuration of channels will increase the aggregation execution time. 6. Select **Save**. ## Filter Conditions for Accounts and Groups For Slack, filtering of records for accounts and groups is optional. The user can request a subset of resources by specifying the `filter` URL query parameter containing a filter expression. The following rules must apply: - The `filter` parameter must contain a valid Boolean operator. - Each expression must contain an attribute name followed by an attribute operator. An optional value is also supported. - Multiple expressions can be combined using two logical operators. - Expressions can be grouped using "( )". - Expressions must be evaluated using a standard order of operations. - Strings must be valid JSON strings. The attribute name and attribute operator are case insensitive. For example, the following expressions equal the same logical value: ```text userName Eq "Carly" username eq "carly" ``` The parameters in the **Aggregation Filter Settings** can use the following filter operators: | Operator | Description | | --- | --- | | co | contains | | sw | starts with | | pr | present (has value) | | gt | greater than | | ge | greater than or equal | | lt | less than | | le | less than or equal | | and | logical and | | or | logical or | ## Advanced Settings > [!NOTE] > > **Screenshot** > > [![Advanced Settings]()]() 1. Select **Advance Settings** from the menu. 2. In **Maximum Retry Count Limit**, enter a number to set up a limit to support the retry mechanism. The aggregation and provisioning operations continue after reaching the rate limit of the Slack API. The minimum value is 1 and maximum value is 10. 3. Select the option to **Enable Complex Attribute Support** for the attributes from the Slack managed system. 4. Select the option to **Enable Default Connector Provider** to handle chunked data on an open JDK version 11. 5. Cache creation is enabled for the Slack source by default. Select the option to **Disable Channel Caching** to reduce the aggregation execution time and use a sequential approach. 6. Update source operations are supported using the PATCH method. Select the option to enable **HTTP Patch Support** if you want to use this method. 7. Select the option to **Enable HTTP Proxy** for an error-free test connection when the proxy is configured as HTTPS proxy. 8. Select **Save**. ## Multiple Group Entitlements for Pre-existing Sources For the pre-existing Slack sources, perform the following steps to start using the Multiple Group Entitlements with your current source. Use [createSchema]() API to create new group schema for your source. Here is an example of API body content for adding entitlements to an existing source. ```json { "id": " 2c918092789290c60178e8e0fad7503e", "name": "channel", "nativeObjectType": "channel", "identityAttribute": "id", "displayAttribute": "name", "hierarchyAttribute": null, "includePermissions": false, "features": [ "PROVISIONING" ], "configuration": {}, "attributes": [ { "name": "id", "type": "STRING", "schema": null, "description": "ID of the Slack channel.", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "name", "type": "STRING", "schema": null, "description": "Name of the Slack channel.", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "created", "type": "STRING", "schema": null, "description": "The time stamp when channel is created.", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "creator", "type": "STRING", "schema": null, "description": "User ID of the member who created the channel.", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "num_members", "type": "STRING", "schema": null, "description": "Number of members in the channel.", "isMulti": false, "isEntitlement": false, "isGroup": false }, { "name": "channel_type", "type": "STRING", "schema": null, "description": "Type of the Slack channel.", "isMulti": false, "isEntitlement": false, "isGroup": false } ], "created": "2021-04-19T06:46:01.687Z", "modified": null } ``` Ensure the channel attribute is added to your source in SailPoint. If not, go to the **Account Schema** of your source and add a channel attribute with the following properties: ```text name="channels" entitlement="true" managed="true" multi="true" schemaObjectType="channel" type="string" ``` ## 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 Slack Slack is a proprietary business communication platform developed by Slack Technologies. Slack allows communities, groups, or teams to join a workspace through a specific URL or invitation sent by a workspace administrator or owner. Connecting SailPoint to your Slack system allows you to manage the Slack user accounts. This guide is designed to provide information about the necessary requirements and definitions needed to get a working instance of a Slack source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Slack source supports the following features: > [!IMPORTANT] > > Before you can use any of the following items marked with an asterisk (\*), SailPoint must activate the feature for your site. - Aggregate Slack users, groups, and channels - \*Provision Slack users - \*Access Certifications (certification of entitlements connected to accounts) - \*Password Management - API Rate Limit: Imposed rate limits with a retry mechanism are supported. The aggregation and provisioning operations continue after reaching the rate limit of the Slack API. For more information on features, refer to [Source Features](). The Slack source supports multiple group objects. The group objects are groups and channels. ### Accounts | Feature | Users | | --- | --- | | Create, Update, Delete | ✔ | | Aggregate | ✔ | | Password Management | ✔ | | Enable, Disable | ✔ | | Group Entitlements (Read, Request, Revoke) | Groups, Channels | ### Group Entitlements Group Entitlements are the entitlement types for which SailPoint provides the ability to aggregate additional details (of the entitlement types) from the managed system. These objects have a separate schema defining list of attributes that the aggregation task fetches (as additional details) when aggregation is run for the Group Entitlement type. | Feature | Groups | Channels | | --- | --- | --- | | Aggregation | ✔ | ✔ | **Slack 'Group' group object**: a group of users. **User Group**: a group of members in a single workspace that need to be notified. **Channel**: consists of details such as the number of members, ID, and name of the channel along with the timestamp of when the channel is created. **Channel management**: involves actions such as viewing a list of channels in a workspace and taking action, if required. ### Supported Slack Platforms - Slack Business Plus Plan - Slack Enterprise Grid Plan > **Note** > > Feature Enhancement: Single and multi-channel guest user creation via SailPoint. This feature allows a user to create another user to have restricted access to a single channel or multiple channels as specified by the user. These users are treated as guest users and do not have access to other channels in the workspace. ### 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](). ## Required Permissions The Slack Connector requires the following permissions and considerations: - The service account that accesses the Slack APIs must be an administrator user in the Slack managed system. - On Slack-Plus, only the Slack owners can generate a token to use the SCIM API. The account that generates a token must remain an owner to make SCIM updates. - Org-wide apps must be installed by an administrator or owner of an Enterprise Grid organization. Additionally, the app must be installed on the entire org, not just an individual workspace. ### Slack Business Plus Requires the Following Permissions User token scopes: - admin - Administrator of a workspace. - channels:read - View basic information about public channels in a workspace. - channels:write - Manage a user's public channels and create new ones on a user's behalf. - groups:read - View basic information about a user's private channels. - groups:write - Manage a user's private channels and create new ones on a user's behalf. - im:read - View basic information about a user's direct messages. - mpim:read - View basic information about a user's direct messages. - users:read - View the people in a workspace. - users:write - Set a user's presence. Bot token scopes: - users:read - View the people in a workspace. - users:read.email - View email addresses of the people in a workspace. ### Slack Enterprise Grid Requires the Following Permissions Channel management requires the following permissions: - An account must be a Workspace owner or administrator. - OAuth requires the following for an account to manage channels: - admin - admin.users:write - channels:read - channels:write - admin.conversations:read - admin.conversations:write - users:read.email > **Note** > > The `channels:write` and `admin.conversations:write` permissions are required only for provisioning operations. Workspace management requires the following permissions: - An account must be a Workspace owner or administrator. - Bot and OAuth requires the following for an account to manage Workspaces: - admin.teams:read - admin.teams:write - Required to make changes on a Workspace. - admin.users:read - Required to access a Workspace's profile information. ## Prerequisites - You have the Slack-Plus plan (single workspace). > **Note** > > SCIM APIs for Slack are available only with the Slack-Plus plan. - Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](). - Generating an OAuth Token Required to Access the Slack API: For the Slack source, users are the members of a workspace and must have a valid OAuth token with required permissions. All the operations by users are performed through SCIM based APIs. An OAuth token with admin level privileges must be used to access the APIs. For more information, refer to [API Token Generation](<#generating-an-oauth-api-token>). - Make sure you select **org-wide** while installing the Slack app to have permissions on the org level. - The App should have `admin` permissions on the User token. - Perform the following steps to provide access for all workspaces to the issued user token: 1. Go to **Enterprise Grid \> Manage Organization \> Installed Apps \> Add to more workspaces**. 2. Select all the workspaces and then select **Save**. ### Generating an OAuth API Token An OAuth API token with the admin scope is required to access the Slack SCIM API. To acquire the OAuth API token an organization owner must: - create a new Slack application - add the admin OAuth scope - install the application - use the generated token Perform the following steps to generate an OAuth API token: 1. Create a new Slack application as an admin on a Workspace. For more information, refer to [Creating, managing, and building apps](). 2. Configure the permissions to allow your application to interact with the Slack API by adding the admin OAuth scope in the User Token Scopes. 3. Install the Slack application. For more information, refer to [Installing and distributing apps](). 4. Use the generated OAuth Access token. > [!NOTE] > > If you intend to build a Slack application for other teams to install, your application will be required to properly handle the OAuth flow to generate the correct token. #### Additional Information The API token must be included through an `Authorization` header with a type of `Bearer` when calling any of the SCIM methods. Provide a JSON request body for POST, PUT, and PATCH write operations, and then set HTTP Content-type header to `application/json`. For example, the SCIM call can be as follows: ```text GET /scim/v1/Users?count=1000 HTTP/1.1 Host: api.slack.com Accept: application/json Authorization: Bearer xoxp-4956040672-4956040692-6476208902-xxxxxx ``` # Provisioning The Slack connector supports provisioning, allowing you to create and manage accounts and entitlements in Slack 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 When your system provisions new accounts to the Slack source, it uses the attributes on the Create Profile page as instructions or a template for what to include in the account. This page is also referred to as the provisioning policy. > [!IMPORTANT] > > The following section outlines the default **Create Profile** configuration and the information required for new Slack accounts and users. You may need to edit the contents as per your requirements. SailPoint recommends that you [work with Services]() if you need assistance with the configuration. The following are the create account provisioning policy attributes of the Slack Source. | Attribute Name | Description | | --- | --- | | userName | Specify the user name of the user. | | givenName | Specify the first name of the user. | | familyName | Specify the last name of the user. | | displayName | Specify the display name of the user. | | password | Specify the login password for the user. | | emails.work.primary.value | Specify the primary work email address for the user. | | userType | Specify the user type of the user. | | employeeNumber | Specify the employee number of the user. | | department | Specify the department for the user. | | locale | Specify the locale of the user. | | timezone | Specify the timezone of the user. | | is\_ultra\_restricted | Specify True for single channel guest user. | | is\_restricted | Specify True for multi channel guest user. | | team\_id | Specify the team ID of the workspace. | | startDate | Specify the date the user started. This attribute is optional. Enter the value in ISO 8601 format. For example, `2000-05-06T00:00:00+0000`. | ## Default Create Group Attributes The following is the create group provisioning policy attribute of the Slack Source: | Attribute Name | Description | | --- | --- | | displayName | The name of the user. | # 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 Slack connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Slack source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | username | Equals | SailPoint User Name (uid) | | emails.work.primary.value | Equals | Work Email (email) | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | id | Account | | id | Group | | id | channel | | id | workspace | ### Default Account Attributes The Slack connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | id | A unique identifier for a Slack resource. | | userName | Name of the user. | | externalId | A String that is an identifier for the resource. | | displayName | The name of the user. | | nickName | The casual way to address the user in real life. | | profileUrl | A fully qualified URL to a page representing the users online profile. | | title | The users title. | | userType | Used to identify the organization to user relationship. | | preferredLanguage | Indicates the users preferred written or spoken language. | | locale | Used to indicate the users default location for purposes of localizing items. | | timezone | The users time zone in the Olson timezone database format. | | familyName | The last name of the user. | | givenName | The first name of the user. | | honorificPrefix | The honorific prefix(es) of the user. | | employeeNumber | Numeric or alphanumeric identifier assigned to a person. | | costCenter | Identifies the name of a cost center. | | organization | Identifies the name of an organization. | | division | Identifies the name of a division. | | department | Identifies the name of a department. | | managerID | The id of the Slack resource representing the users manager. | | emails | Email addresses for the user. | | emails.work.primary.value | Primary work email address for the user. | | emails.work.secondary.value | Secondary work email addresses for the user. | | phoneNumbers | Phone numbers for the user. | | phoneNumbers.work.primary.value | Primary work phone number for the user. | | phoneNumbers.mobile.value | Mobile number for the user. | | photos | URL of a photo of the user. | | photo.photo.value | URL of a photo of the user. | | addresses | A physical mailing address for the user. | | addresses.home.streetAddress | Home Street address for the user. | | addresses.home.locality | Home address locality for the user. | | addresses.home.region | Home address region for the user. | | addresses.home.postalCode | Home address postal code for the user. | | addresses.home.country | Home address country for the user. | | groups | A list of groups that the user belongs to. | | roles | A list of roles for the user that collectively represent who the user is. | | created | The date and time details of the account when it was added to Slack. | | startDate | The date the user started. This attribute is optional. The value uses ISO 8601 format. For example, `2000-05-06T00:00:00+0000`. | | location | The URL of the user being returned. | | channels | Channels assigned to the user. | | workspaces | Workspaces assigned to the user. | | is\_ultra\_restricted | The value of this attribute should be true if the user is a single channel guest user. The default value is "false" (Boolean). | | is\_restricted | The value of this attribute should be true if the user is multi-channel guest user. The default value is "false" (Boolean). | > [!NOTE] > > The `channels` attribute increases the aggregation execution time. ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Slack connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups. #### Entitlement Type: group Object Type: group | Attribute Name | Description | | --- | --- | | id | A unique identifier for the group. | | displayName | The name of the group. | | created | The date and time details of the group when it was added to Slack. | | location | The URL of the group being returned. | #### Entitlement Type: channel Object Type: channel | Attribute Name | Description | | --- | --- | | id | ID of the Slack channel. | | name | The name of the Slack channel. | | created | The timestamp when the channel is created. | | creator | The User ID of the member who created the channel. | | num\_Members | The number of members in the channel. | | channel\_type | The type of the Slack channel. | | teamId | The team ID associated with the Slack channel. | #### Entitlement Type: workspace Object Type: workspace | Attribute Name | Description | | --- | --- | | id | A unique identifier for the Workspace. | | name | The Workspaces name. | | primary\_owner | The user ID for the Workspaces owner. | | team\_url | The Workspaces URL. | # Migrate VA-based Source to a SaaS Source Some sources that are connected to virtual appliance (VA) clusters can be migrated to SaaS connections. This ensures data (users and entitlements) remain intact and can maintains your source configurations like access profiles, roles, password settings, and correlation configurations when switching from a VA cluster to a SaaS connection. To migrate a source from a VA-based source to a SaaS source, you will provide configuration details on a draft version of the source before publishing the source. > [!NOTE] > > - You must have an Admin or Source Admin user level to migrate a source. A draft version of the source is created. As your migration process is in progress the live source will continue to work as it is. For more information on the Slack SaaS connector, refer to the [Slack SaaS Supported Features](). ## Important Considerations Before Migrating - You do not need to edit additional configurations (other than connection credentials) to migrate the source. - If your source migration is in progress, please do not make any configuration changes to your live source as those can be overwritten once you apply the migration your draft version. - Once you've gone ahead with your migration, it can't be rolled back. Your source is permanently migrated to a SaaS source. - Any preview operations or configuration changes on the draft source will not impact the live source until you apply the migration. ## Migrating Sources To migrate your source, complete the following: 1. Go to **Admin \> Connections \> Sources**. 2. Select or edit the VA-based source you want to migrate. 3. Open the source configuration, and select **Migrate to SaaS**. 4. When prompted, select **Continue**. A draft version of the source is created. The live source will continue to work. 5. Select **Connection Settings**. 6. Re-enter encrypted configuration details. For example, you might need to re-enter the Client Secret, Password, Refresh Token, Personal Access Token (PAT), or Certificates to migrate from the VA cluster to the SaaS connection. > **Important** > > Avoid editing the other configuration options in the draft source. 7. Select **Review and Test**. 8. Select **Test Connection**. 9. (Optional) Select **Accounts**. If you successfully tested your connection in **Review and Test**, you can select **Preview** to display a subset of accounts from the application that will be mapped to SailPoint identities. This can help ensure you are accurately connecting identity data from the application with SailPoint identities. 10. (Optional) Select **Entitlements**. If you successfully tested your connection in **Review and Test** and your source type supports entitlement type configuration, you can select **Preview** to view a preview of entitlements using the current configuration settings. 11. When you've finished reviewing your changes and successfully tested your connection, select **Apply Migration**. Your changes will be applied to the live source and the draft source will be deleted. ## Viewing Source Migration Status You can view the status and creation date of draft sources. 1. Go to **Admin \> Connections \> Sources \> Source Migration Status**. 2. Select **Source Migration Status**. 3. To view or edit the draft source, select **Actions** ![]() **\> Preview** on the draft source. 4. To delete the draft source, select **Actions** ![]() **\> Delete** on the draft source. # 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]() ### Aggregation Errors - `Exception during aggregation. Reason: javax.ws.rs.ProcessingException: Error closing message content input stream.` **Resolution**: Verify that that you correctly set up the **Enable Default Connector Provider** source field in the [Advanced Settings]() section. - `openconnector.ConnectorException: Invalid response or no resource received. Bad Request` **Resolution**: Verify that the values of the configuration parameters such as filter conditions, API URL, and others are valid. - `java.lang.RuntimeException: openconnector.ConnectorException` **Resolution**: Ensure that you correctly set up the **Maximum Retry Count Limit** and entered the value for the maximum retry count in the Slack source. The default value is 5. - Account aggregation fails to retrieve the associated channels with an account. **Resolution**: Ensure that you correctly set up the **Manage Channels** source field and the service account token has the following administrator permissions: `admin`, `channels:read`. - An error message is displayed while performing group aggregation: `connector exception :openconnector.ConnectorException{"ok":false,"error":"team_access_not_granted"}` **Resolution**: Verify the auth token application is installed on Workspace. ### Provisioning Error - `openconnector.ConnectorException: Bad Request` **Resolution**: Ensure that the mandatory attributes required to create a resource on Slack are provided, and that the input data is valid and not duplicate. ### Increase in Account Preview Execution Time When **Manage Channels** is configured, the account preview execution time increases. **Resolution**: Cache creation is enabled in the Slack source by default. To reduce the aggregation execution time, run sequential approach by setting the **Disable Channel Caching** option in [Advanced Settings](). ### Test Connection Errors While proxy is configured as HTTPS proxy, the test connection fails with the following error message: `Test connection failed. Unrecognized SSL message, plaintext connection?` **Resolution**: Ensure that you correctly set up the **Enable HTTP Proxy** option in [Advanced Settings](). ### managerID Is Not Updated for the User If the user is disabled in the managed system, the managerID of the user cannot be updated. **Resolution**: Ensure the user is active on the managed system, and then, perform the update operation. ### phoneNumbers.mobile.value Is Not Updated for the User The Slack connector updates `phoneNumbers.work.primary.value` instead of `phoneNumbers.mobile.value` during provisioning. **Resolution**: To enable provisioning of `phoneNumbers.mobile.value`, set `updateMobilePhoneViaWork` to true in the application XML. # 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" } ] ```