# 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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>). 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](<https://documentation.sailpoint.com/saas/help/va/index.html>).
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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
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](<https://documentation.sailpoint.com/saas/help/sources/index.html#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](<https://documentation.sailpoint.com/saas/help/va/index.html>).
   - **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](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
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](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
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](<https://documentation.sailpoint.com/saas/help/va/index.html>).
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](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
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](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-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](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_conn.png>)](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_conn.png>)

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](<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](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>).

> [!NOTE]
>
> **Screenshot**
>
> [![Aggregation Settings](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_agg.png>)](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_agg.png>)

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](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_adv.png>)](<https://documentation.sailpoint.com/connectors/slack/va/help/img/slack_adv.png>)

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](<https://developer.sailpoint.com/docs/api/create-source-schema-v-1/>) 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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.