# SailPoint Ziflow Connector Documentation

> Ziflow Connector Documentation

# Documentation

# Connecting SailPoint and Ziflow

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 Ziflow API base endpoint as **Base URL**. For example, `https://api.ziflow.io/v1`.
2. Enter the **API Token**. This token is used to authenticate requests made by the connector.
3. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Integrating SailPoint with Ziflow

Ziflow is a cloud-based online proofing and creative review platform for organizations that need to streamline how creative content moves through review, feedback, and approval across teams and stakeholders. It combines centralized feedback management, automated review workflows, annotation and markup tools, version control, and routing/automation into a single unified system, providing real-time visibility into review status, feedback consolidation, and approval progress - across virtually any creative asset type (images, video, documents, web pages, audio) from first draft through final sign-off. This document provides instructions to configure a new direct connection to a Zoflow 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 Ziflow connector supports the following:

### Account Management

- Aggregate Users

### Entitlement Management

- Aggregate Roles
- Aggregate Groups

> [!NOTE]
>
> This connector is read-only. It supports account and entitlement aggregation for Quick Compliance. Provisioning, de-provisioning, and write operations are not supported.

> [!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 configuring the Ziflow connector, ensure the following requirements are met:

1. Sign in to Ziflow with an administrator account (API key access is available to administrators on Free, Standard, Pro, and Enterprise plans).
2. Go to **Settings \> API Settings \> General** to review and manage API access for your account.
3. Select your **profile avatar** in the lower-left corner of Ziflow and choose **View profile**.
4. Select the **API Key** tab near the bottom of the profile page.
5. Select the **copy icon** next to the key to copy your **API Key** (generated automatically per user - no separate enable step is required).
6. Copy and securely store the following details, which are required during connector configuration:

   - **API Key** (used for header-based authentication on all API calls)
   - **Base URL** - `https://api.ziflow.io/v1`

> [!NOTE]
>
> - Ziflow's API key is tied to an **individual user's profile**, not the account as a whole - each user with API access generates their own personal key under **View profile \> API Key**. There is no separate company-wide/shared token.
> - Because the key is personal, **deactivating or offboarding the staff member who generated it will likely break any integration using it**. Ziflow recommends creating the connector under a dedicated **service/role-based account** (not a named individual) so access isn't lost if that person leaves the organization.
> - **Regenerating the key immediately invalidates the old one** - there's no documented grace period or dual-key overlap, so any integration still using the previous key will fail right away and must be reconfigured with the new key before it works again.

For more detailed information on obtaining an access token, refer to the official Ziflow documentation: [Welcome to the Ziflow API](<https://api-docs.ziflow.com/#section/Welcome-to-the-Ziflow-API>).

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

## Required Permissions

### Roles That Can Generate Tokens

Ziflow's default roles include **User**, **Manager**, **Billing**, and **Admin** (Free and Standard editions offer Manager, Billing, or Admin; Pro and Enterprise editions add the User role as well). Since the API Key lives under each individual's own profile rather than a company-level setting, generating a key isn't gated behind a special "API" permission - it's tied to whether the user role has access to **Settings** at all.

- **Admin** - Required at minimum. Admins have access to the Settings area (including **API Settings**) and can view/copy their own API Key from **View profile \> API Key**. This is the minimum role needed to generate a token for yourself.
- **Account Owner** - Has full permissions equivalent to a user assigned all four roles (User, Billing, Manager, and Admin) combined. The Account Owner can also manage account-wide API-related settings under **Settings \> API Settings \> General**, transfer ownership, and manage other users' roles - but is not required just to generate a personal API key; Admin is sufficient for that.
- **Manager / User / Billing roles alone** - Do **not** have Settings access by default, and therefore cannot reach the API Key tab, unless an Enterprise admin has explicitly granted them access via **Custom Permissions** (**Settings \> Permissions**), which lets Enterprise accounts override default role restrictions on a per-feature basis.

# 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 Ziflow 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 |
| --- | --- |
| id | Account |

### Default Account Attributes

The Ziflow 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 | Unique numeric identifier assigned to the user record |
| email | User's email address, used for login and notifications |
| firstName | User's given (first) name |
| lastName | User's family (last) name |
| active | Indicates whether the user account is currently active or inactive |
| roles | Display array of the role assigned to the user (for example, "Admin", "manager") |
| group | Array of the group names user belongs to |
| verified | Indicates whether the user account is verified |

## 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 Ziflow 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 | Display name of the role |

### Default Group Attributes

The Ziflow 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 |
| --- | --- |
| name | Display name of the group |