# SailPoint Cloudiway Connector Documentation

> Cloudiway Connector Documentation

# Documentation

# Connecting SailPoint and Cloudiway

To connect SailPoint to the source, perform the following tasks:

## Adding and Configuring 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.

1. Go to **Admin \> Connections \> Sources**.
2. Select **Create New**.
3. Search for a source type and select **Actions**.
4. In the **Actions** dropdown, select the setup method:

   - **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** - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup.

### Express Setup

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**
   >
   > Source name must be unique.
3. (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>).
4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** page.
5. 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.

### Standard Setup

Configure more detailed settings relative to Express Setup.

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. (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>).
5. 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>).
6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Here, continue to configure your connected source.

## 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 descriptive **Source Name** for the connection.
2. Enter the **Source Description** that provides details necessary to distinguish it from similar connection sources.
3. In **Source Owner**, begin typing the name of the source owner.
4. (Optional) Select the appropriate **Governance Group for Source Management** from the dropdown list. 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>).
5. Select **Create Manual Work Items** to enable the source to support additional source management features such as creating accounts and access profile management.

   > **Important**
   >
   > Once you enable this feature, it can't be disabled.

   For more information on manual work items, refer to [Work Items](<https://developer.sailpoint.com/docs/api/work-items>). For more information on SailPoint features, refer to [SailPoint Identity Services](<https://documentation.sailpoint.com/saas/help/index.html>).
6. Select **Save**.

## Connection Settings

Configure a secured, direct connection to the source.

1. Enter the Cloudiway API base endpoint as **Base URL**. For example, `https://api-production.cloudiway.com`.
2. Enter the name you entered in New Personal Access Token as **PAT Name**.
3. Enter the PAT token value as **PAT Token**.
4. Enter the Collection ID as **Collection ID**.
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 Cloudiway

Cloudiway is a cloud migration and coexistence platform used to move and synchronize mail, files, sites, Teams, and groups between Microsoft 365, Google Workspace, and other tenants. Customers work inside the Cloudiway portal: they create a collection (the account workspace), create migration projects under that collection, and invite team members to run and monitor those migrations. Cloudiway exposes portal operators and the role catalog through the Cloudiway REST API. This document provides the instructions required to configure a new direct connection between SailPoint and Cloudiway. For a reference to the terminology specific to SailPoint products, refer to [Source and Connector Definitions](<https://documentation.sailpoint.com/saas/help/sources/index.html#source-and-connector-definitions>).

> [!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 Cloudiway connector supports the following:

### Account Management

- Aggregate Users

### Entitlement Management

- Aggregate Roles

> [!IMPORTANT]
>
> Quick Compliance connectors have the following manual aggregation limits within a 24-hour period:
>
> - **Organization Admins**: Limited to 3 manual account or entitlement aggregations per day per source. This limit is cumulative across all admins in the organization.
> - **Regular Users**: Limited to 1 manual account or entitlement aggregation per day per source.
>
> These limits ensure that individual compliance statuses are kept up to date while maintaining continuous compliance monitoring. If you need to run additional aggregations beyond these limits, contact SailPoint Support.

## Prerequisites

Before you configure the Cloudiway connector, ensure the following requirements are met:

- Sign in to the [Cloudiway portal](<https://portal.cloudiway.com/register>).
- Create a Personal Access Token (PAT):

  1. Go to **Account \> APIs**.
  2. Select **New Token**, and enter a name for it. This name is required at configuration time - Cloudiway authenticates on the name and the token value together.
  3. Select a project from the dropdown. The token is created in the context of that project.
  4. Set an expiry. Choose a date far enough out that scheduled aggregations keep working.
  5. Copy the token value. Cloudiway shows it once.
- Copy the Collection ID. Cloudiway does not show the collection id as a labeled field in the UI. To get it:

  1. In the portal, select **Create Project**.
  2. Look at the browser address bar. The URL includes `collectionId`, for example: `https://portal.cloudiway.com/homepage/project-edit?collectionId=11320`
- Copy and securely store the following details, which are required during connector configuration:

  - **Base URL**
  - **PAT Name**
  - **PAT Token**
  - **Collection ID**

> [!NOTE]
>
> - The Cloudiway connector uses Custom Authentication. You do not paste a bearer token into the source. The connector posts the PAT name and PAT token to `POST /ap1/Authentication/TechnicalLogin`, receives a short-lived JWT, and sends that JWT as `Authorization: Bearer <token>` on every subsequent call. The connector re-authenticates on each run, so there is no manual JWT refresh - the PAT itself is the credential you maintain, until the expiry date you set when creating the token.
> - All API requests must use HTTPS; unencrypted HTTP calls are not supported and will fail.
> - Credentials should be stored securely and treated like a password.

For more detailed information on Cloudiway API authentication, refer to the [official Cloudiway documentation](<https://api-production.cloudiway.com/index.html>).

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

## Required Permissions

Cloudiway uses role-based access at the collection level. Available roles:

- **Viewer** - Read-only access. Can view project details, license summary, and migration logs, and monitor progress.
- **Contributor** - Can run migrations. Includes everything a Viewer can do, plus start and manage migrations, configure migration settings, and run audits and preprocessing.
- **Administrator** - Full access to the collection.
- **SuperAdminCloudiway** - Internal Cloudiway role. Not assigned when you invite operators.
- **SalesAdminCloudiway** - Internal Cloudiway role. Not assigned when you invite operators.
- **SupportAdminCloudiway** - Internal Cloudiway role. Not assigned when you invite operators.
- **ProductionAdminCloudiway** - Internal Cloudiway role. Not assigned when you invite operators.
- **SupportCloudiwayL2** - Internal Cloudiway role. Not assigned when you invite operators.

# 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 Cloudiway 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(User) |

### Default Account Attributes

The Cloudiway 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 | Unique numeric identifier of the portal operator |
| displayName | Login email of the portal operator |
| roleName | The role assigned to the operator on the collection |
| roleId | Identifier of the role assignment record |

## 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 Role Attributes

The Cloudiway connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.

| Attribute Name | Description |
| --- | --- |
| name | Role name, used as both the entitlement ID and the entitlement display name |
| id | Catalog identifier of the role definition, reference only |
| parentId | Catalog identifier of the parent role in the role hierarchy |