# SailPoint Atlassian Suite Cloud Connector Documentation

> Atlassian Suite Cloud Connector Documentation

# Documentation

# Connecting SailPoint and Atlassian Suite Cloud

To connect SailPoint with Atlassian Suite, 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

Provide the information required for SailPoint to connect and authenticate with Atlassian Suite Cloud.

1. Go to **Connection Settings**.
2. Enter the **Site URL** (HTTPS API URL) for the cloud instance. For example:

   `https://contoso.atlassian.net`
3. Choose the appropriate Authentication Type and provide the information required to connect and interact with the source. The following Authentication Types are supported:

   - Basic
   - Service Account

### Basic Authentication

1. Enter the **Email Address** of the Atlassian Jira instance administrator account that you want to configure to execute transactions.
2. Enter the **Site Admin API Token** for the instance administrator. The Site Admin API Token is generated in the source.

   For more information, refer to [Manage API tokens for your Atlassian account](<https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/>) in the Atlassian documentation.

   > **Note**
   >
   > The linked document is not maintained by SailPoint and is subject to change without notice.

   > **Note**
   >
   > Atlassian API tokens don’t use selectable scopes like OAuth scopes. They inherit the creator’s Atlassian roles, so use an account with the required admin role when creating the token. Create the API token without scope.

> [!NOTE]
>
> If Atlassian Profile Visibility restrictions are applied in your environment, standard Site Administrator API tokens will not have access to read user email addresses. In such cases, the API token used for the connector must be generated by an Organization Administrator to bypass these privacy settings. For more information refer to [Profile visibility overview](<https://developer.atlassian.com/cloud/jira/platform/profile-visibility/>).

> [!NOTE]
>
> **Screenshot**
>
> [![Basic Authentication connection settings](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/basic_authentication_1.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/basic_authentication_1.png>)

### Service Account Authentication

1. Enter the Email Address of the Atlassian Jira service account.
2. Enter the **Service Account API Token**.
3. Use a scoped API token generated for a service account that has Jira product access and the required permissions. The token must include these classic scopes:

   - `read:jira-work`
   - `read:jira-user`
   - `manage:jira-configuration`
   - `manage:jira-project`

   For more information, refer to [Manage API tokens for service accounts](<https://support.atlassian.com/user-management/docs/manage-api-tokens-for-service-accounts/>).
4. (Optional) Enter **Confluence Scoped API Token** for NHI Discovery from Confluence.

> [!NOTE]
>
> The linked document is not maintained by SailPoint and is subject to change without notice.

> [!NOTE]
>
> **Screenshot**
>
> [![Service Account Authentication connection settings](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/service_account_authentication.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/service_account_authentication.png>)

Once the Authentication Type is selected perform the following steps:

1. (Optional) Enter the **Org Admin API Token** for the instance administrator. This is required to enable/ disable accounts and activity insights. The Org Admin API Token is generated in the source.

   For more information, refer to [Manage an organization with the admin APIs](<https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/>) in the Atlassian documentation.

   > **Note**
   >
   > The linked document is not maintained by SailPoint and is subject to change without notice.
2. (Optional) Enter the **Connection Timeout** (in minutes) to hold the connection with the Atlassian system in an idle state. The default is 1 minute.
3. Select **Save**.

## Aggregation Settings

Configure the aggregation parameters such as filter conditions and page size. Use a semicolon delimiter to add multiple filter conditions.

For more information about aggregation, refer to [Loading Account Data](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>).

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_add1.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_add1.png>)

1. Go to **Additional Settings \> Aggregation Settings**.
2. (Optional) Select **Include Inactive Users** to enable the setting. When enabled, inactive users are aggregated along with active users. The setting is disabled by default.
3. (Optional) Enter the **Filter Conditions for Accounts** to filter accounts during aggregation. Only strings are supported as a filter condition. For multiple conditions, use a semicolon delimiter. For example:

   - For single conditions, `john` aggregates only those accounts whose display name or email prefix contain the name john.
   - For multiple conditions, `john;chris` aggregates all users whose display name or email prefix are john or chris.
4. (Optional) In the **Page Size** field, enter the number of records to fetch per page. The default is 50 records per page. The minimum value is 1 and the maximum is 1000.
5. Select **Save**.

### Advanced Settings

In this section, you can provide settings for API Version, Thread Count, and Connection Timeout.

> [!NOTE]
>
> SailPoint recommends that you do not change the default settings. Changing the settings could result in performance issues.

> [!NOTE]
>
> **Screenshot**
>
> [![alt text](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_add2.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_add2.png>)

1. Go to **Additional Settings \> Advanced Settings**.
2. (Optional) Select the **API Version** to use for the connection. The default is 2.
3. (Optional) In the **Thread Count** field, specify the maximum number of threads for account aggregation. The default is 8.
4. (Optional) Enter the **Connection Timeout in Minutes** to hold the HTTP connection with the Atlassian system in an idle state. The default is 1 minute.
5. 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](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with Atlassian Suite Cloud

Atlassian is a leading product company providing tools for collaboration and service desk. SailPoint's Atlassian Suite Cloud connector supports reading and provisioning of Atlassian users and groups. Use the Atlassian Suite Cloud source to manage Atlassian Suite user accounts. After it is successfully configured, your organization is able to aggregate and provision accounts for Jira users and manage access to other Atlassian Suite products such as Confluence and Jira Service Management by managing memberships of groups having access to the respective products.

This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of the Atlassian Suite Cloud source.

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The Atlassian Suite Cloud connector supports the features listed on this page.

> [!NOTE]
>
> Before you can use any feature marked with an asterisk (\*), SailPoint must activate the feature for your site.

### Account Management

- Aggregate accounts
- Add and remove entitlements
- \*Provision accounts

  - Create new accounts
  - Enable and disable managed accounts

    > **Note**
    >
    > Accounts must be claimed accounts from verified domains. For more information, refer to [Claim accounts](<https://support.atlassian.com/user-management/docs/verify-a-domain-to-manage-accounts/#Claim-accounts>) and [Verified domains in your organization](<https://support.atlassian.com/user-management/docs/verify-a-domain-to-manage-accounts/#Verified-domains-in-your-organization>) in the Atlassian documentation. Atlassian documentation is not managed by SailPoint and is subject to change without notice.
- \*Access Certifications (certification of entitlements connected to accounts)
- Multiple Group Objects and Direct Permissions
- Delete Accounts

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

The following table lists the account feature details:

| Feature | Users |
| --- | --- |
| Aggregate | ✔ |
| Create | ✔ |
| Group Entitlements (Read, Request, Revoke) | Groups and Project Roles |
| Enable Direct Permissions | ✔ |

### Group Entitlements

Group Entitlements enable SailPoint to aggregate additional details from the managed system. These objects have a separate schema attribute definition list that the aggregation fetches when aggregation is run for that Group Entitlement type.

The following table lists the group feature details:

| Feature | Groups | Project Roles |
| --- | --- | --- |
| Aggregation | ✔ | ✔ |

> [!NOTE]
>
> We recommend not updating the group name, as the connector uses the name as the `identityAttribute` in the group schema. Changing the group name will cause the entitlement to be recreated and the old entitlement will be deleted.

## Supported Managed Systems

The SailPoint Atlassian Suite Cloud connector supports the following Atlassian products:

- Jira Software (Cloud)
- Jira Service Management
- Opsgenie
- Statuspage
- Confluence

> [!NOTE]
>
> The Jira Administrator can manage the Default Access group associated with different products. Users created from SailPoint are automatically assigned to the default Product Access Groups enabled on the managed system.

## Prerequisites

- Configure at least one virtual appliance cluster and successfully test the connection. For more information, refer to the [Virtual Appliance Reference Guide](<https://documentation.sailpoint.com/saas/help/va/index.html>).

  - Network Requirements

    Outbound access for port 443 (HTTPS) from the VA
- Whitelist the following URL on the VAs:

  `https://<domain>.atlassian.net` where `<domain>` is the domain name configured by the customer.

  `https://api.atlassian.com`
- The client is authorized using basic authentication which uses a Site Admin API Token. The token is encoded, and it is generated by user account with **Site Admin** access. It is added to headers for API requests.

  For more information on generating Site Admin API tokens, refer to [Manage API tokens for your Atlassian account](<https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/>) in the Atlassian documentation.

  > **Note**
  >
  > Atlassian API tokens don't use selectable scopes like OAuth scopes. They inherit the creator's Atlassian roles, so use an account with the required admin role when creating the token. Create the API token without a scope. The linked document is not maintained by SailPoint and is subject to change without notice.

  > **Screenshot**
  >
  > [![API Tokens](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_api_token.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_api_token.png>)
- Enabling or disabling accounts uses token authentication. It needs an Org Admin API Token generated by a user with **Org and Site Admin** access.

  For more information on generating API tokens, refer to [Manage an organization with the admin APIs](<https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/>) in the Atlassian documentation.

  > **Note**
  >
  > Atlassian API tokens don't use selectable scopes like OAuth scopes. They inherit the creator's Atlassian roles, so use an account with the required admin role when creating the token. Create the API token without a scope.

  > **Screenshot**
  >
  > [![API key without scopes selection](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_before_you_begin.png>)](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/img/atl_suite_c_before_you_begin.png>)

### For Service Account Authentication

- The client is authorized using the email address of an Atlassian service account and a Service Account API Token. Use a scoped API token generated for a service account that has Jira product access and the required permissions. The token must include these classic scopes:

  - `read:jira-work`
  - `read:jira-user`
  - `manage:jira-configuration`
  - `manage:jira-project`

  For more information, refer to [Manage API tokens for service accounts](<https://support.atlassian.com/user-management/docs/manage-api-tokens-for-service-accounts/>).

## Required Permissions

- The service account must be a Site Admin User (Site Admin/ jira-administrators) with an API token created on the Atlassian Suite managed target system.
- To support enabling and disabling accounts, the service account must be a Org and Site Admin User with an Org Admin API token created on the Atlassian Suite managed target system.

# Using Multiple Group Entitlements

For pre-existing Atlassian Suite Cloud sources, complete the following steps to start using the Multiple Group Entitlements feature with your current source.

1. Use the [createSchema API](<https://developer.sailpoint.com/docs/api/create-source-schema-v-1/>) to create new group schema for your source. Here is an example for API body content for adding Project Roles to an existing source.

   ```javascript
   {
   "nativeObjectType": "ProjectRole",
   "identityAttribute": "projectRoleId",
   "displayAttribute": "displayName",
   "hierarchyAttribute": null,
   "includePermissions": false,
   "features": [],
   "configuration": {},
   "attributes": [
   {
   "name": "name",
   "type": "STRING",
   "schema": null,
   "description": "Name of the Project Role",
   "isMulti": false,
   "isEntitlement": false,
   "isGroup": false
   },
   {
   "name": "displayName",
   "type": "STRING",
   "schema": null,
   "description": "Display name of the Project Role",
   "isMulti": false,
   "isEntitlement": false,
   "isGroup": false
   },
   {
   "name": "projectRoleId",
   "type": "STRING",
   "schema": null,
   "description": "An unique identifier for the project specific roles",
   "isMulti": false,
   "isEntitlement": false,
   "isGroup": false
   },
   {
   "name": "id",
   "type": "STRING",
   "schema": null,
   "description": "An unique identifier for the project role",
   "isMulti": false,
   "isEntitlement": false,
   "isGroup": false
   },
   {
   "name": "description",
   "type": "STRING",
   "schema": null,
   "description": "The description of the Project Role",
   "isMulti": false,
   "isEntitlement": false,
   "isGroup": false
   }
   ],
   "name": "ProjectRole"
   }
   ```
2. Update **Account Schema** using the following steps:

   1. Get account schema using the [getSchema](<https://developer.sailpoint.com/docs/api/get-source-schema-v-1/>) API.
   2. Copy the schema to a file and search for the attribute corresponding to the group schema that was added in step 1.
   3. Add/Update these properties for the attribute found in previous step (2.b.):

      ```javascript
      "isGroup": true, 
      "schema": {"type": "CONNECTOR_SCHEMA",
      "id": "<Schema_ID_From_Step1>",
      "name": "<Name_Of_Schema_Created_In_Step1>"}
      ```
   4. Add the schema modified in step 2.c. to the payload to update account schema in source using the [replaceSchema](<https://developer.sailpoint.com/docs/api/put-source-schema-v-1/>) API.

# Provisioning

The Atlassian Suite Cloud connector supports provisioning, allowing you to create and manage accounts and entitlements in Atlassian Suite 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 generators create the required information for a new Atlassian Suite Cloud account:

| Account Attributes | Identity Attribute | Description |
| --- | --- | --- |
| emailAddress | Work Email | The email address of the user<br><br>**Note**: If there is any issue with the aggregation of the `emailAddress` attribute, note that the `emailAddress` attribute is aggregated only for accounts from those domains that belong to the service account's domain. |
| displayName | Display Name | The display name of the user |

> [!NOTE]
>
> For more information on setting the mapping types, refer to [Editing the Account Creation Configuration](<https://documentation.sailpoint.com/saas/help/provisioning/create_profile.html#editing-the-account-creation-configuration>).

# 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](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The Atlassian Suite Cloud connector uses the following default correlation and object configurations.

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) 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 |
| --- | --- |
| accountId | Account |
| name | Group |
| projectRoleId | Project Role |

### Default Account Attributes

The Atlassian Suite Cloud 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 |
| --- | --- |
| accountId | A unique identifier for an Atlassian user. This is an Account ID which must not be changed. |
| accountType | The type of account that the user belongs to. |
| displayName | The display name of the user. |
| emailAddress | The email address of the user. The emailAddress attribute is only fetched for accounts in the same domain as the service account. |
| timeZone | The timezone of the user. |
| locale | The default location of the user for the purpose of localizing items. |
| groups | The list of groups that the user belongs to. |
| projectRoles | The list of roles that the user belongs to. |

> [!NOTE]
>
> The `emailAddress` attribute is only fetched for accounts in the same domain as the service account.

## 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](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) 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 Atlassian Suite Cloud connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

| Attribute Name | Description |
| --- | --- |
| groupId | A unique identifier for the group. |
| name | The name of the group. This is an Account ID which must not be changed. |
| labels | The description (labels) of the group. |

### Default Project Role Attributes

| Attribute Name | Description |
| --- | --- |
| name | The name of the project role. |
| displayName | The display name of the project role. |
| projectRoleId | A unique identifier for the project specific roles combining Role ID and its corresponding Project ID. This is an Account ID which must not be changed. |
| id | A unique identifier for the project role. |
| description | The description of the project role. |

# 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 Atlassian Suite Cloud SaaS connector, refer to the [Atlassian Suite Cloud SaaS Supported Features](<https://documentation.sailpoint.com/atl_cloud/saas/help/index.html#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** ![](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/common/assets/img/actions_menu.png>) **\> Preview** on the draft source.
4. To delete the draft source, select **Actions** ![](<https://documentation.sailpoint.com/connectors/atl_cloud/va/help/common/assets/img/actions_menu.png>) **\> 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](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Enabling or Disabling an Account Fails

**Issue**: Enabling/disabling an account fails with the error: `Error while disabling account: Unauthorized`

**Resolution**: Cross-check the attribute encrypted in the source config and verify whether the `adminApiToken` is missing in the value section. Then append the `adminApiToken` values using the following API request.

Add the following entry to the source using the SailPoint REST APIs:

`PATCH 'https://{orgName}.api.sailpoint.com/v3/sources/<source-id>'`

In the body of the `PATCH`, use the raw-data as follows:

```javascript
{
        "op": "add",
        "path": "/connectorAttributes/encrypted",
        "value":  "apiToken,adminApiToken"
    }
```

## Command Times Out During Provision or Enable/Disable Operations

**Issue**: A command times out during provision or enable/disable operations.

**Resolution**: Set the `provisioningTimeout` attribute to `600`.

Update the provisioningTimeout attribute as follows:

```javascript
[
    {
        "op": "add",
        "path": "/connectorAttributes/provisioningTimeout",
        "value": 600
    }
]
```

## Single Account Aggregation Failure Involving the ProjectRole Attribute

**Issue**: Single account aggregation fails when the entitlement attribute `ProjectRole` is present in the account schema.

**Resolution**: Add the following entry to ensure that membership aggregation of Project Roles is skipped with the ResourceObject (RO) as incomplete. Sending the RO as incomplete ensures that the existing Project Role assignments are not removed from SailPoint. Full aggregation is not impacted by this entry.

```javascript
key : skipProjectRoleForGetObject
value : true
```

## Project Role Entitlement Aggregation Failure; Stream Timeout

**Issue**: Entitlement aggregation fails for object type `ProjectRole` with:

`An internal error occurred handling stream response from the server`

This happens when Project Role aggregation runs longer than the default stream timeout. The connector must walk projects and their roles before returning the stream, so large sites can exceed the limit.

**Resolution**: Increase the aggregation timeout on the source so the Project Role stream can complete. Account aggregation and other entitlement types are not affected by this entry.

```javascript
key: aggregateTimeout
value: 3600
```

# 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](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) 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"
    }
]
```