# SailPoint Webex Control Hub Connector Documentation > Webex Control Hub Connector Documentation # Documentation # Connecting SailPoint and Webex Control Hub To connect SailPoint with Webex Control Hub, 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. ## Connection Settings This task enables you to configure the connection between SailPoint and your Webex Control Hub source. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **API URL** to connect the Webex Control Hub system. 2. Select **OAuth 2.0** as the authentication type. 3. Select a **Grant Type** for OAuth 2.0 authentication. 4. Enter the **Token URL** to request an access token for a user. 5. Enter the **Client ID** for the application. 6. Enter the **Client Secret** to authenticate the client ID. 7. Enter a valid **Refresh Token** the doesn't expire or which has a long expiration period. 8. Enter the **Org ID** provided by the application. 9. Select **Save**. ## 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 Webex Control Hub. To enable Activity Insights for the Webex Control Hub 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 following settings requirement for aggregation: For more information about aggregation, refer to [Loading Account Data](). > [!NOTE] > > **Screenshot** > > [![Account and group filter settings]()]() > [!NOTE] > > **Screenshot** > > [![Page size aggregation settings]()]() 1. In the **Account Filter** field, enter account filter conditions to define the scope of the account aggregation process. For more information for filter, refer to [Account Filter](). 2. In the **Group Filter** field, enter group filter conditions needed to define the scope of the group aggregation process. For more information for filter, refer to [Group Filter](). 3. In the **Page Size** field, enter the number of records to aggregate in a single page when iterating over large datasets. You can set from 1 to 100. The default is 100. 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 Webex Control Hub This guide is designed to give specific information about the requirements and field definitions needed to get a working instance of a Webex Control Hub source. Webex Control Hub is the central interface for managing organization, users, and services like messaging, meetings, calling, video podcasts, and more. It allows you to view usage data, assign services, and keep track of everything in one place. Control Hub is the administrative portal for all of Cisco's cloud collaboration products, making it easy to manage all Webex Services from a single interface. To manage Webex Control Hub user account data, either create an [identity profile]() based on the source or verify that the accounts you load are [correlated]() to an existing identity. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The Webex Control Hub connector supports the following features: #### Account Management - Manage Users as Accounts - Aggregate Users - Read, Create, Update, and Delete - Enable/Disable User #### Group Management - Add/Remove Entitlements (Groups , Roles, and License) from the User - Aggregate Entitlements (Groups, Roles, and License) For more information on features, refer to [Source Features](). ## Prerequisites The following prerequisite are required: - The integration app must be set up on the Webex Control Hub Manage system. For more information, refer to [Webex Control Hub Integration](). - The minimum scope settings that you need to configure while creating the Webex Control Hub Integration are as follows: - `spark:all` - `spark-admin:licenses_read` - `spark-admin:people_read` - `spark-admin:people_write` - `spark-admin:roles_read` - `identity:people_rw` - `identity:people_read` - `spark-compliance:events_read` - `audit:events_read` ## Required Permissions A user must have access to the following specified endpoints to perform necessary operations: - `GET: /identity/scim/{orgId}/v2/Users` - `POST: /identity/scim/{orgId}/v2/Users` - `PATCH: /identity/scim/{orgId}/v2/Users/{userId}` - `DELETE: /identity/scim/{orgId}/v2/Users/{userId}` - `GET: /identity/scim/{orgId}/v2/Groups` - `GET: /v1/roles` - `GET: /v1/licenses` - `GET /v1/people` A user with read-only permissions requires access to the following endpoints to perform necessary operations: - `GET: /identity/scim/{orgId}/v2/Users` - `GET: /identity/scim/{orgId}/v2/Groups` - `GET: /v1/roles` - `GET: /v1/licenses` - `GET: /v1/people` - `v1/adminAudit/events` - `v1/events` ## Supported Managed Systems The SailPoint Webex Control Hub connector supports the following managed system: - Webex Control Hub # Machine Account Attributes ## Machine Account Provisioning Attributes The following table lists the attributes in the machine account creation template. | Attribute | Label | Type | Required | Initial Value | | --- | --- | --- | --- | --- | | userName | User Name | string | Yes | Static: Enter email for this machine account | | userType | User Type | string | Yes | Static: user | | name.honorificPrefix | Honorific Prefix | string | No | Disable | | name.givenName | First Name | string | No | Disable | | name.middleName | Middle Name | string | No | Disable | | name.familyName | Last Name | string | No | Disable | | nickName | Nick Name | string | No | Disable | | displayName | Display Name | string | No | Disable | | title | Title | string | No | Disable | | active | Active | boolean | No | Static: True | | preferredLanguage | Preferred Language | string | No | Disable | | locale | Locale | string | No | Disable | | timezone | Timezone | string | No | Disable | | profileUrl | Profile URL | string | No | Disable | | addresses.type | ADDRESSES\_TYPE | string | Yes | Disable | | addresses.streetAddress | Street Address | string | No | Disable | | addresses.locality | Locality | string | No | Disable | | addresses.region | Region | string | No | Disable | | addresses.postalCode | Postal Code | string | No | Disable | | addresses.country | Country | string | No | Disable | For more information, refer to [Machine Identity Security Overview](). # Provisioning The Webex Control Hub connector supports provisioning, allowing you to create and manage accounts and entitlements in Webex Control Hub 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 | | --- | --- | --- | | userName | Identity Attribute | The unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same userName value and thus is required to be unique within Webex. | | userType | Static | Used to identify the relationship between the organization and the user. | | name.honorificPrefix | Disable | The honorific prefix(es) of the user, or title in most Western languages (e.g., "Ms." given the full name "Ms. Sarah J Henderson, III"). | | name.givenName | Disable | The given name of the user, or first name in most Western languages (e.g., "Sarah" given the full name "Ms. Sarah J Henderson, III"). | | name.middleName | Disable | The middle name(s) of the user (e.g., "Jane" given the full name "Ms. Sarah Jane Henderson, III"). | | name.familyName | Disable | The family name of the user, or last name in most Western languages (e.g., "Henderson" given the full name "Ms. Sarah J Henderson, III"). | | nickName | Disable | A casual name of the user. For example, Bob when the user's formal name is Robert. | | displayName | Disable | The name displayed for the user in Webex. | | title | Disable | The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. | | active | Static | A Boolean value of "true" or "false" indicating whether the user is active in Webex. | | preferredLanguage | Disable | The user's preferred language. | | locale | Disable | The user's locale which represents the user's currency, time format, and numerical representations. | | timezone | Disable | The user's time zone specified in the IANA timezone timezone format, for example, "America/ Los\_Angeles". | | profileUrl | Disable | A fully qualified URL pointing to a page representing the user's online profile. | | address.type | Disable | The type of the address. e.g. 'work', 'home' etc. | | addresses.streetAddress | Disable | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain new lines. | | addresses.locality | Disable | The city or locality component of the user's address. | | addresses.region | Disable | The state or region component of the user's address. | | addresses.postalCode | Disable | The ZIP code or postal code component of the user's address. | | addresses.country | Disable | The country name component of the user's address. | # 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 Webex Control Hub 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 Webex Control Hub source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | userName | Equals | Work email | | emails.work.primary.value | Equals | Work email | | displayName | Equals | displayName | ## 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 | | id | role | | id | license | ### Default Account Attributes The Webex Control Hub 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 | Webex Identity assigned user's identifier. This is an Account ID which must not be changed. | | username | A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same userName value and thus is required to be unique within Webex. | | active | A Boolean value of "true" or "false" indicating whether the user is active in Webex. | | accountStatus | Account status indicating whether the user's status in Webex. | | name.givenName | The given name of the user, or first name in most Western languages (e.g., "Sarah" given the full name "Ms. Sarah J Henderson, III"). | | name.familyName | The family name of the user, or last name in most Western languages (e.g., "Henderson" given the full name "Ms. Sarah J Henderson, III"). | | name.middleName | The middle name(s) of the user (e.g., "Jane" given the full name "Ms. Sarah Jane Henderson, III"). | | name.honorificPrefix | The honorific prefix(es) of the user, or title in most Western languages (e.g., "Ms." given the full name "Ms. Sarah J Henderson, III"). | | name.honorificSuffix | The honorific suffix(es) of the user, or suffix in most Western languages (e.g., "III" given the full name "Ms. Sarah J Henderson, III"). | | address.type | The type of the address. e.g. 'work', 'home' etc. | | addresses.streetAddress | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain new lines. | | addresses.locality | The city or locality component of the user's address. | | addresses.region | The state or region component of the user's address. | | addresses.postalCode | The ZIP code or postal code component of the user's address. | | addresses.country | The country name component of the user's address. | | displayName | The name displayed for the user in Webex. | | nickName | A casual name of the user. For example, Bob when the user's formal name is Robert. | | emails.work.primary.display | A human-readable description for the user's primary work email, primarily used for display purposes. | | emails.work.secondary.display | A human-readable description of the user's secondary work email, primarily used for display purposes. | | emails.work.primary.value | The user's primary work email address. | | emails.work.secondary.value | The user's secondary work email address. | | emails.home.primary.display | A human-readable name for the user's primary home email address, primarily used for display purposes. | | emails.home.secondary.display | A human-readable name for the user's secondary home email address, primarily used for display purposes. | | emails.home.primary.value | The user's primary home email address. | | emails.home.secondary.value | The user's secondary home email address. | | emails.other.primary.display | A human-readable name for the user's primary tertiary email address, primarily used for display purposes. | | emails.other.secondary.display | A human-readable name for the user's secondary tertiary email address, primarily used for display purposes. | | emails.other.primary.value | The user's primary tertiary email address. | | emails.other.secondary.value | The user's secondary tertiary email address. | | userType | Used to identify the relationship between the organization and the user. | | profileUrl | A fully qualified URL pointing to a page representing the user's online profile. | | title | The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. | | preferredLanguage | The user's preferred language. | | locale | The user's locale which represents the user's currency, time format, and numerical representations. | | externalId | The user's external identity. | | timezone | The user's time zone specified in the IANA timezone timezone format, for example, "America/Los\_Angeles". | | phoneNumbers.work.primary.display | A human-readable name for the user's primary work phone number, primarily used for display purposes. | | phoneNumbers.work.secondary.display | A human-readable name for the user's secondary work phone number, primarily used for display purposes. | | phoneNumbers.work.primary.value | The user's primary work phone number. | | phoneNumbers.work.secondary.value | The user's secondary work phone number. | | phoneNumbers.home.primary.display | A human-readable name for the user's primary home phone number, primarily used for display purposes. | | phoneNumbers.home.secondary.display | A human-readable name for the user's secondary home phone number, primarily used for display purposes. | | phoneNumbers.home.primary.value | The user's primary home phone number. | | phoneNumbers.home.secondary.value | The user's secondary home phone number. | | phoneNumbers.mobile.primary.display | A human-readable name for the user's primary mobile phone number, primarily used for display purposes. | | phoneNumbers.mobile.secondary.display | A human-readable name for the user's secondary mobile phone number, primarily used for display purposes. | | phoneNumbers.mobile.primary.value | The user's primary mobile phone number. | | phoneNumbers.mobile.secondary.value | The user's secondary mobile phone number. | | display | A human-readable name, primarily used for display purposes. | | manager.value | The user's manager's name. | | organization | The user's organization. | | groups | A list of groups to which the user belongs. | | roles | A list of roles to which the user belongs | | licenses | A list of the user's licenses. | | costCenter | The user's cost center. | | department | The user's department. | | sipAddresses.primary.value | SIP address values for the user. | ## 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 Webex Control Hub 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 unique identifier of the group. This is an Entitlement ID which must not be changed. | | displayName | The group's display name. | | externalId | An identifier for the resource as defined by the provisioning client. | | members.value | A list of members of this group. | ### Default Role Attributes The Webex Control Hub 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 | | --- | --- | | id | The unique identifier of the role. This is an Entitlement ID which must not be changed. | | name | The name of the role. | ### License Attributes | Attribute Name | Description | | --- | --- | | id | The unique identifier of the licensed feature. This is an Entitlement ID which must not be changed. | | name | The name of the licensed feature. | | totalUnits | The total number of license units allocated. | | consumedUnits | The total number of license units consumed. | | consumedByUsers | The total number of license units consumed by users. | | consumedByWorkspaces | The total number of license units consumed by workspaces. | | subscriptionId | The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub. | | siteUrl | The Webex Meetings site associated with this license. | | siteType | The type of site associated with this license. | # 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](). ## NullPointerException encountered during account aggregation. **Resolution** - To resolve this issue, verify that the `emails` attribute is included in the account schema during aggregation. If the attribute is missing, add it to the schema configuration and re-run the aggregation process.