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 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. |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.