# SailPoint Zoom SaaS Connector Documentation > Zoom SaaS Connector Documentation # Documentation # Connecting SailPoint and Zoom SaaS To connect SailPoint with Zoom, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 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. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 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](). 6. 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. (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](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (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](). 6. (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. 7. Select **Save**. ## Connection Settings Provide the information required to connect and interact with the source. To configure connection settings, complete the following: > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **URL** path used to connect to the Zoom system. For example, `https://api.zoom.us/v2/` 2. The **Authentication Type** is selected as OAuth 2.0 by default when access token is used for connection. Access tokens are generated based on the selected grant type and a generated token can be used. 3. Select a **Grant Type** from the drop-down list. ### Grant Type: Account Credentials This grant type is used when applications request an access token to access their own resources. This allows the user to supply credentials directly. Enter the following details to configure authentication for account credentials: > [!NOTE] > > For more information on the operations and their required scopes, refer to [Required Permissions](). > [!NOTE] > > **Screenshot** > > [![Grant Type: Account Credentials]()]() 1. Enter the **Token URL** for generating the access token. For example, `https://zoom.us/oauth/token` 2. Enter the **Client ID** and **Client Secret** for OAuth 2.0 authentication. 3. Enter the **Account ID** for OAuth 2.0 authentication. For more information on creating a server to server OAuth 2.0 profile on your Zoom instance, refer to [how to create a Server-to-Server OAuth app](). 4. Select **Save**. > [!IMPORTANT] > > It is recommended to run the **Test Connection** only once during the initial setup. If you try a second time for the test connection, the source will try to generate another token and Zoom will invalidate the saved token. ### Grant Type: Refresh Token This grant type is used in order to exchange a refresh token for a new access token when the existing access token has expired. This allows to get a new session when the current session expires, without having to re-authenticate as frequently. Enter the following details to configure refresh token authentication: > [!NOTE] > > For more information on the operations and their required scopes, refer to [Required Permissions](). > [!NOTE] > > **Screenshot** > > [![Grant Type: Refresh Token]()]() 1. Enter the **Token URL** for generating the access token. For example, `https://zoom.us/oauth/token` 2. Enter the **Client ID** for OAuth 2.0 authentication. 3. Enter the **Client Secret** for OAuth 2.0 authentication. 4. Enter the **Refresh Token** for OAuth 2.0 authentication. For more information on creating an OAuth 2.0 profile on your Zoom instance, refer to [OAuth with Zoom](). 5. Select **Save**. > [!IMPORTANT] > > You must enter the latest refresh token for application operations since Zoom supports rotating refresh tokens. Update and save the refresh token once it is used for test connection with a new refresh token. > > It is recommended to run the **Test Connection** only once during the initial setup. If you try a second time for the test connection, the source will try to generate another token and Zoom will invalidate the saved token. When creating a refresh token ensure all scopes levels are present for operations like create, remove, group, and user. ## Activity Insights Settings SailPoint pulls in activity data in the form of events like user logins, password changes, and content updates within the application. You can view an identity’s activity data within an application to discover trends for that user. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on utilizing activity data, refer to [Activity Insights](). Activity Insights Settings allows you to gather account information and activity data from Zoom. To enable Activity Insights for the Zoom application, refer to [Prerequisites]() for more information. To configure Activity Insights, complete the following: > [!NOTE] > > **Screenshot** > > [![Activity Insights Settings]()]() 1. Go to **Activity Insights Settings**. 2. Select **Enable Activity Insights** to view access to data insights on source and application activity such as logins and other app-specific events. 3. Select **Save**. ## Aggregation Settings Provide the settings for your aggregation. By default, the connector aggregates users with an active status. For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() To configure your aggregation, complete the following: 1. In **Page Size** enter the number of records to be fetched at one time. The default is 300. 2. Select the **Include Inactive Users** checkbox to aggregate users that have deactivated accounts. 3. Select the **Include Pending Users** checkbox to aggregate users that have not confirmed their accounts. 4. Select **Save**. ## Advanced Settings Use the advanced settings to configure token expiry time, license type, and default user creation action. ### Timeout Settings > [!NOTE] > > **Screenshot** > > [![Timeout Settings]()]() ### User License Settings > [!NOTE] > > **Screenshot** > > [![User License Settings]()]() ### Default Action Settings > [!NOTE] > > **Screenshot** > > [![Default Action Settings]()]() To configure advanced settings, complete the following as needed: 1. Enter the **Token Expiry Timeout in Minutes**. The JWT token expires after the specified time. 2. Select the **User License Type** from the following options: - Basic - Licensed - On-Prem For any other user type, the correct value is the corresponding integer assigned by the Zoom API. Refer to the [Zoom documentation](). 3. Select the **Default Action** for user privileges on creation from the following options: - Create - Auto Create - Cust Create - SSO Create 4. 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]() in the SailPoint SaaS documentation. # Integrating SailPoint with Zoom SaaS This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of the Zoom SaaS connector that supports version 2.0 of the Zoom API. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features SailPoint's Zoom SaaS connector supports the following features: ### Account Management > [!NOTE] > > Before you can use any item marked with an asterisk (\*), SailPoint must activate the feature for your site. - Entitlement Aggregation - \*Password management (Change Password) - Delete Accounts - Load and \*provision Zoom Accounts (Enable/Disable) - \*Access Certifications (certification of entitlements connected to accounts) For more information on features, refer to [Source Features](). The Zoom SaaS connector supports the following Zoom objects: - Zoom Users as SailPoint Users - Zoom Web Groups: This is an entitlement object that can be assigned to and removed from, a user of a web group. ### Activity Insights Activity Insights supports activity from Zoom and its associated accounts. This allows you to gather account information and activity data from Zoom. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on configuring Activity Insights, refer to Activity Insights Settings. ### Password Management If Password Management is enabled for your organization, you can change the password for a user of the source. After enabling password management on the source, be aware of the following: - The password policy defined in SailPoint applies to accounts on this source. - If you change the password for an application connected to this source, the change will automatically be made to the source itself. For more information on configuring password management, refer to [Password Management Overview](). ## Supported Managed Systems The Zoom SaaS connector supports Zoom API version 2.0. ## Prerequisites - SailPoint's Zoom SaaS connector uses rotating refresh tokens authentication from Zoom. After first use of the refresh token for a test connection with the connector, you must save the new refresh token. When creating a refresh token ensure all scopes levels are present for operations like create, remove, group, and user. For more information, refer to [OAuth with Zoom](). ## Required Permissions Zoom is introducing Classic and granular scopes to allow users to be more specific about the level of access granted to third-party apps. For more information on scopes, refer to [OAuth Scopes](). ### Classic Scopes Classic scopes provide a way to limit the amount of access granted to an app. Zoom has user-level, admin-level, and Master-level scopes. Previously-created apps use the previously-available scopes, now called classic scopes. If you upgrade your app you will still be able to use classic scopes. The following scopes are required for aggregation, provisioning, and deprovisioning: - user:read:admin - user:write:admin - account:read:admin - account:write:admin - group:read:admin - group:write:admin - meeting:read:admin - meeting:write:admin The minimum requirements for scopes and their connector operations are as follows: | Connector Operation | Scope | | --- | --- | | User - Read + Write (Create, Update, Enable, Disable, Entitlement Assignment, and Removal) | user:write:admin | | Group - Read + Write (Aggregation and Get Groups) | group:write:admin | ### Granular Scopes Granular scopes enable developers to practice the principle of least privilege so that users can provide access to the minimal amount of information required by your app. Newly created apps use granular scopes, including new apps created using the new build flow. New apps can also set which scopes are required and which are optional. The following scopes are required for aggregation, provisioning, and deprovisioning: - user:read:list\_users:admin - user:read:user:admin - group:read:list\_groups:admin - user:update:status:admin - user:write:user:admin - group:write:member:admin - group:delete:member:admin - user:update:password:admin - user:update:user:admin The requirements for scopes and their connector operations are as follows: | Connector Operation | Scope | | --- | --- | | User - Read + Write (Create, Update, Enable, Disable, and Removal) | user:read:list\_users:admin
user:read:user:admin
user:write:user:admin
user:update:status:admin
user:update:password:admin
user:update:user:admin | | Group - Read + Write (Aggregation, Add groups, Remove Groups) | group:read:list\_groups:admin
group:write:member:admin
group:delete:member:admin | ### For Activity Insights An administrator requires the following additional permission to utilize the Activity Insights: | Description | Scope | | --- | --- | | View a user's usage reports | report:read:user:admin | | View users usage reports | report:read:list\_users:admin | | View a meeting's participant | meeting:read:participant:admin | For more information on configuring Activity Insights, refer to [Activity Insights Settings](). # Machine Account Attributes ## Machine Account Provisioning Attributes Machine account creation uses the same attribute keys as standard account creation, but uses different generators. The following table lists the machine account creation attributes. | Attribute | Type | Required | Generator | Description | | --- | --- | --- | --- | --- | | first\_name | string | Yes | Static | The first name of the machine account. Enter a first name for the machine account. | | last\_name | string | No | Static | The last name of the machine account. Enter a last name for the machine account. | | email | string | No | Static | The email address of the machine account. Enter an email address for the machine account. | | verified | string | No | Disable | Indicates whether the machine account has verified its email address. | | action | string | No | Disable | The action used to create an account. The default value is `create`. | | type | string | No | Disable | The license type for the machine account. The default type is `basic`. | | password | string | No | Disable | The password of the machine account. This attribute applies only when the `autoCreate` option is selected. | For more information, refer to [Machine Identity Security Overview](). ### Classification The Classification attribute is used to identify and categorize the account as a machine account. - **Attribute name** - UserType - **Value** - Communication, Reference, Service, System # Provisioning The Zoom SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in Zoom 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 | Account Attribute | Generator | Description | | --- | --- | --- | | action | Disable | This is the action to create an account. The default value is `create`. | | email | Identity Attribute | The email address of the user. | | type | Disable | The license type for the user. The default type is `basic`. | | first\_name | Identity Attribute | The first name of the user. | | last\_name | Identity Attribute | The last name of the user. | | password | Disable | The password of the user. Only applicable when the `autoCreate` option is selected. | ## Limitations on Pending Users Update This section provides important information on the limitations related to the Zoom managed system's APIs. There are the following related use cases: - **Creation of pending User Account and Add/Remove Entitlement**: In the user creation process, the Zoom managed system sends an email with a confirmation link to activate the Zoom account. The user can then set or change the password. The status of the created user is pending until the user verifies the email. The pending user is created, however due to Zoom API behavior an entitlement is not assigned on the Zoom managed system. The Zoom API does not display an error, the Zoom connector has this entitlement as assigned until the next round of full aggregation. The Zoom connector supports creation of active users with a **custCreate** action of the Zoom managed system. For more information, refer to the [Zoom Developer]() documentation. - **Attribute update on pending user**: For the update of any attribute for a pending user, the request is successful, but is not reflected on the Zoom managed system. - **Email update**: The Zoom API displays the following error: ```text Domain name doesn't match. Please contact the Zoom Customer Support to set managed domains for your account. ``` The error indicates that the email domain name does not match. The managed domain must be set to update the email ID. For more information, refer to the [Zoom Developer]() documentation. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The Zoom SaaS connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the Zoom SaaS source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | email | Equals | Work Email (email) | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account ID SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*. > [!CAUTION] > > Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts. > > To resolve issues caused by changing account IDs, reconfigure them to their default values. The following table lists the default account IDs for this connector: | Account ID | Schema Object Type | | --- | --- | | id | Account | | id | Group | ### Default Account Attributes The Zoom SaaS 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 | The unique Zoom User ID. | | full\_name | The full name of a user. First Name + Last name. | | first\_name | The users first name. | | last\_name | The users last name. | | email | The users email address. | | status | The users status. | | dept | The department of the user. | | verified | Shows whether the user has verified their email or not. | | last\_login\_time | The users last login time. | | type | The users license type. | | group\_ids | The IDs of the web groups the user belongs to. | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Default Group Attributes The Zoom SaaS 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 | | --- | --- | | id | The web group ID. | | name | The web group name. | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Test Connection Fails with Expired Access Token The test connection fails and displays the following error: ```text [InvalidConfigurationException][Possible suggestions] Verify the access token expiry. [Error details] Expired access token. ``` This error occurs when you try to make a test connection for the second time with the managed system. **Resolution**: It is advised not to run the test connection if the source is healthy. Instead try to run the Account/Entitlement aggregation manually. For more information, refer to [Connection Settings]() to update the token for the chosen grant type authentication.