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 Meetings 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 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 |
|---|---|
| WebexID | Account |
| MeetingTypeID | Group |
Default Account Attributes
The Webex Meetings 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 |
|---|---|
| WebexID | The Webex ID of the user. |
| FirstName | The first name of the user. |
| LastName | The last name of the user. |
| The email ID of the user. | |
| RegistrationDate | The creation date of the user |
| Active | Indicates whether the user account has been staged for use. Default: ACTIVATED Note: If you set the user's active parameter to ACTIVATED such that the Webex Meetings site's host limit is exceeded, the CreateUser or SetUser command displays the following error: exceededSiteHostLimit |
| TimezoneID | Indicates the time zone for the geographic location of the meeting. |
| Company | The user's company name. |
| Description | A description of the user's virtual office. |
| CategoryID | A reference to the office category for the user's office. |
| AddressType | Indicates whether the meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. |
| Country | The country for the user. |
| Phone | The user's Office Profile phone number. |
| MobilePhone | The attendee's mobile phone number. |
| Fax | The fax number for the user. |
| Pager | The user's Office Profile pager number. |
| PersonalURL | The user's website. |
| ExpirationDate | A Webex Meetings-maintained date and time at which the user's account expires. |
| Prod/ServiceAnnouncement | Product or service announcements. |
| TrainingInfo | Training information. |
| ElectronicInfo | Electronic information. |
| Promos | Promotions and special offers. |
| PressRelease | Press releases. |
| UserEmail | The email address as stored in the user profile. |
| UserPhone | The phone number for the user. |
| MailInfo | The mail information for the user. |
| TimeZone | The time zone for the geographic location of the user or user's office. |
| TimeZoneWithDST | A timezone description which is adjusted by DST. For example, GMT-7:00, Pacific (San Francisco) |
| Service | The type of service that the user has. |
| Host | Indicates whether the user is the host for the meeting. |
| TelephoneConferenceCallOut | Indicates whether conference calling out of meetings is supported for the meeting. |
| TelephoneConferenceCallOutInternational | Indicates whether international calling out of meetings is supported for the meeting. |
| TelephoneConferenceCallIn | Indicates whether conference calling into meetings is supported for the meeting. |
| TelephoneConferenceTollFreeCallIn | Indicates whether toll-free calling into meetings is supported for the user. |
| SiteAdmin | Indicates whether the user has administrative privilege for the meeting. |
| VOIP | Specifies whether Voice Over IP telephony is enabled. |
| SiteAdminwithViewOnly | Indicates whether the current user is a site administrator with view only privilege. |
| LabAdmin | If TRUE, then the user has access to the Hands-on Lab administration pages. |
| OtherTeleConferencing | Indicates whether a user account has the privilege to schedule a session with the other teleconferencing feature enabled. Default value depends on the configurations on the user's website. |
| TeleConferenceCallInInternational | Allows a user to access Webex Meetings teleconferencing through international local call-in telephone numbers. |
| AttendeeOnly | If the value is TRUE, indicates that the user's role is attendee only. If the value is set to TRUE, then the host, siteAdmin, labAdmin, and roSiteAdmin elements should be FALSE. |
| RecordingEditor | Indicates whether a user has the privilege to download the Webex Meetings Recording Editor from My Webex > Support. |
| MeetingAssist | Enables Meeting Assist. |
| MeetingType | The meeting types of which the account is a part of. |
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 Meetings 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 |
|---|---|
| ProductCodePrefix | Indicates the product label for the type of meeting. |
| Active | Indicates whether the type of meeting represented by an object of this type is enabled or disabled. |
| DisplayName | The display name for the meeting type. |
| PrimaryTollCallInNumber | The telephone number for a toll call-in teleconference. |
| PrimaryTollFreeCallInNumber | The telephone number for a toll free call-in teleconference. |
| GroupName | The name of the group or meeting type. |
| MeetingTypeID | Specifies IDs for the meeting types whose detailed information you want to get. |
| ServiceType | The type of meeting being returned. |
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.