[Index]

Model: relation/WebExClient

WebEx User add/mod/del relation.

Model Details: relation/WebExClient

Title Description Details
Data User Group Assigned by FDP
  • Field Name: Data User
  • Type: Object
User Name * User's Username.
  • Field Name: Data User.username
  • Type: String
First Name The User first name.
  • Field Name: Data User.first_name
  • Type: String
Last Name The User last name.
  • Field Name: Data User.last_name
  • Type: String
Password The User password.
  • Field Name: Data User.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: Data User.role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • Format: uri
Email Address The User email address.
  • Field Name: Data User.email
  • Type: String
Ldap User
  • Field Name: LDAPUser.[n]
  • Type: Array
  • Cardinality: [0..1]
LDAP Username * The login attribute of the associated LDAP device model instance
  • Field Name: Data User.LDAPUser.[n].ldap_username
  • Type: String
Data Username The data username that is mapped to the associated LDAP device model instance.
  • Field Name: Data User.LDAPUser.[n].data_username
  • Type: String
  • Target: data/User
  • Target attr: username
  • Format: uri
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: Data User.LDAPUser.[n].ldap_server
  • Type: String
  • Target: data/Ldap
  • Format: uri
Sso User
  • Field Name: SSOUser.[n]
  • Type: Array
  • Cardinality: [0..1]
SSO Identity Provider * The entity id of the SSO Identity Provider.
  • Field Name: Data User.SSOUser.[n].sso_idp
  • Type: String
  • Target: data/SsoIdentityProvider
  • Target attr: entity_id
  • Format: uri
SSO Username * The name identifier that is used for an SSO authenticated user.
  • Field Name: Data User.SSOUser.[n].sso_username
  • Type: String
Data Username The data username that is mapped to the associated SSO authenticated user.
  • Field Name: Data User.SSOUser.[n].data_username
  • Type: String
  • Target: data/User
  • Target attr: username
  • Format: uri
WebEx User Group Assigned by FDP
  • Field Name: WebEx User
  • Type: Object
Web Ex User
  • Field Name: WebExUser.[n]
  • Type: Array
  • Cardinality: [0..1]
Web Ex Id *
  • Field Name: WebEx User.WebExUser.[n].webExId
  • Type: String
  • Cardinality: [1..1]
User Id Default: -1
  • Field Name: WebEx User.WebExUser.[n].userId
  • Type: Integer
  • Cardinality: [0..1]
  • Default: -1
First Name *
  • Field Name: WebEx User.WebExUser.[n].firstName
  • Type: String
  • Cardinality: [0..1]
Last Name *
  • Field Name: WebEx User.WebExUser.[n].lastName
  • Type: String
  • Cardinality: [0..1]
Email *
  • Field Name: WebEx User.WebExUser.[n].email
  • Type: String
  • Cardinality: [0..1]
Active *
  • Field Name: WebEx User.WebExUser.[n].active
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["ACTIVATED", "REQUEST_TO_ACTIVATE", "DEACTIVATED"]
Password *
  • Field Name: WebEx User.WebExUser.[n].password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 60
Privilege
  • Field Name: privilege
  • Type: Object
  • Cardinality: [0..1]
Is Enable CET
  • Field Name: WebEx User.WebExUser.[n].privilege.isEnableCET
  • Type: Boolean
  • Cardinality: [0..1]
Is Enable PMR
  • Field Name: WebEx User.WebExUser.[n].privilege.isEnablePMR
  • Type: Boolean
  • Cardinality: [0..1]
Attendee Only
  • Field Name: WebEx User.WebExUser.[n].privilege.attendeeOnly
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out
  • Field Name: WebEx User.WebExUser.[n].privilege.teleConfCallOut
  • Type: Boolean
  • Cardinality: [0..1]
Ro Site Admin
  • Field Name: WebEx User.WebExUser.[n].privilege.roSiteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Voice Over Ip
  • Field Name: WebEx User.WebExUser.[n].privilege.voiceOverIp
  • Type: Boolean
  • Cardinality: [0..1]
Allow Ext Attendees
  • Field Name: WebEx User.WebExUser.[n].privilege.allowExtAttendees
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call Out International
  • Field Name: WebEx User.WebExUser.[n].privilege.teleConfCallOutInternational
  • Type: Boolean
  • Cardinality: [0..1]
Meeting Assist
  • Field Name: WebEx User.WebExUser.[n].privilege.meetingAssist
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Toll Free Call In
  • Field Name: WebEx User.WebExUser.[n].privilege.teleConfTollFreeCallIn
  • Type: Boolean
  • Cardinality: [0..1]
H Dvideo
  • Field Name: WebEx User.WebExUser.[n].privilege.HDvideo
  • Type: Boolean
  • Cardinality: [0..1]
Host
  • Field Name: WebEx User.WebExUser.[n].privilege.host
  • Type: Boolean
  • Cardinality: [0..1]
Recording Editor
  • Field Name: WebEx User.WebExUser.[n].privilege.recordingEditor
  • Type: Boolean
  • Cardinality: [0..1]
Site Admin
  • Field Name: WebEx User.WebExUser.[n].privilege.siteAdmin
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In
  • Field Name: WebEx User.WebExUser.[n].privilege.teleConfCallIn
  • Type: Boolean
  • Cardinality: [0..1]
Tele Conf Call In International
  • Field Name: WebEx User.WebExUser.[n].privilege.teleConfCallInInternational
  • Type: Boolean
  • Cardinality: [0..1]
Other Telephony Default: True
  • Field Name: WebEx User.WebExUser.[n].privilege.otherTelephony
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Lab Admin
  • Field Name: WebEx User.WebExUser.[n].privilege.labAdmin
  • Type: Boolean
  • Cardinality: [0..1]
H Qvideo
  • Field Name: WebEx User.WebExUser.[n].privilege.HQvideo
  • Type: Boolean
  • Cardinality: [0..1]
Security
  • Field Name: security
  • Type: Object
  • Cardinality: [0..1]
Reset Password
  • Field Name: WebEx User.WebExUser.[n].security.resetPassword
  • Type: Boolean
  • Cardinality: [0..1]
CUCM User Group Assigned by FDP
  • Field Name: CUCM User
  • Type: Object
Cucm User
  • Field Name: CUCMUser.[n]
  • Type: Array
  • Cardinality: [0..1]
Userid * Enter the unique end user identification name. You can enter any character, including alphanumeric and special characters. No character restrictions exist for this field. You can modify the user ID only for local users. For LDAP synchronized users, you can view the user ID, but you cannot modify it. Note    We recommend that you do not use a slash (/) in the User ID field. Cisco User Data Services will not function properly for the user when the User ID contains a slash.
  • Field Name: CUCM User.CUCMUser.[n].userid
  • Type: String
  • Cardinality: [1..1]
First Name Enter the end user first name.
  • Field Name: CUCM User.CUCMUser.[n].firstName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Last Name * Enter the end user last name.
  • Field Name: CUCM User.CUCMUser.[n].lastName
  • Type: String
  • Cardinality: [1..1]
Confirm Password This field does not display for LDAP Synchronized users if LDAP Authentication is enabled. Enter the end user password again.
  • Field Name: CUCM User.CUCMUser.[n].password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
User Profile
  • Field Name: CUCM User.CUCMUser.[n].userProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/UserProfileProvision
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Confirm PIN Enter the PIN again.
  • Field Name: CUCM User.CUCMUser.[n].pin
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Self Service The Meeting Number is generated automatically when the Self-Service User ID field is configured.
  • Field Name: CUCM User.CUCMUser.[n].selfService
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#]{0,27}$
User Locale From the drop-down list box, choose the locale that is associated with the end user. The user locale identifies a set of detailed information to support end users, including language and font. Unified Communications Manager uses this locale for extension mobility and the Cisco Unified Communications Self Care Portal. For Cisco Extension Mobility login, the locale that is specified takes precedence over the device and device profile settings. For Cisco Extension Mobility logout, Unified Communications Manager uses the end user locale that the default device profile specifies. Note    If you do not choose an end user locale, the locale that is specified in the Cisco CallManager service parameters as Default User Locale applies.
  • Field Name: CUCM User.CUCMUser.[n].userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
BLF Presence Group * Use this field to configure the BLF Presence feature. From the drop-down list box, choose a BLF presence group for the end user. The selected group specifies the destinations that the end user can monitor. The default value for BLF Presence Group specifies Standard Presence group, configured with installation. BLF Presence Groups that are configured in Cisco Unified Administration also appear in the drop-down list box. BLF Presence Group authorization works with BLF Presence Groups to allow or block presence requests between groups.
  • Field Name: CUCM User.CUCMUser.[n].presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Enable Extension Mobility Cross Cluster Check this box to enable this end user to use the Cisco Extension Mobility Cross Cluster feature. For more information about the Cisco Extension Mobility Cross Cluster feature, see the Feature Configuration Guide for Cisco Unified Communications Manager.
  • Field Name: CUCM User.CUCMUser.[n].enableEmcc
  • Type: Boolean
  • Cardinality: [0..1]
SUBSCRIBE Calling Search Space Supported with the BLF Presence feature, the SUBSCRIBE calling search space determines how Unified Communications Manager routes presence requests that come from the end user. This setting allows you to apply a calling search space separate from the call-processing search space for presence (SUBSCRIBE) requests for the end user. From the drop-down list box, choose the SUBSCRIBE calling search space to use for presence requests for the end user. All calling search spaces that you configure in Cisco Unified CM Administration appear in the SUBSCRIBE Calling Search Space drop-down list box. If you do not select a different calling search space for the end user from the drop-down list box, the SUBSCRIBE calling search space defaults to None. To configure a SUBSCRIBE calling search space specifically for this purpose, you configure a calling search space as you do all calling search spaces.
  • Field Name: CUCM User.CUCMUser.[n].subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Enable Mobility Check this check box to activate Cisco Unified Mobility, which allows the user to manage calls by using a single phone number and to pick up in-progress calls on the desktop phone and cellular phone. Checking this check box triggers licensing to consume device license units for Cisco Unified Mobility.
  • Field Name: CUCM User.CUCMUser.[n].enableMobility
  • Type: Boolean
  • Cardinality: [0..1]
Enable User for Unified CM IM and Presence (Configure IM and Presence in the associated UC Service Profile) Check this check box to enable the end user (on the home cluster) for IM and Presence. Configure IM and Presence in the associated service profile. Note    IM and Presence does not function properly if an end user is assigned to more than one home cluster. Note    You must install a Unified Communications Manager IM and Presence node along with this Unified Communications Manager cluster. Use the User Management > User Settings > UC Services menu to configure the IM and Presence service.
  • Field Name: CUCM User.CUCMUser.[n].imAndPresenceEnable
  • Type: Boolean
  • Cardinality: [0..1]
UC Service Profile To revert to the System Default Service Profile value, select any value from the drop-down, blank it (i.e. delete ALL text) and submit.
  • Field Name: CUCM User.CUCMUser.[n].serviceProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ServiceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Directory Uri Enter the directory URI that you want to associate to this end user. A directory URI looks like an email address and follows the user@host format. For information about valid formats for directory URIs, see Directory URI formats in the "Intercluster Directory URI" chapter of the Cisco Unified Communications Manager Administrative Guide. Note    If you enter a directory URI and also enter a directory number in the Primary Extension field, this directory URI automatically becomes the primary directory URI that is associated to that directory number.
  • Field Name: CUCM User.CUCMUser.[n].directoryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 254
  • Pattern: ^[^@]{1,47}@[^@]+$
IPCC Extension From the drop-down list box, choose an IPCC extension for this end user. Note    This field appears only if the IPCC Express Installed enterprise parameter is set to True.
  • Field Name: CUCM User.CUCMUser.[n].ipccExtension
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Associated Devices Also known as controlled devices.
  • Field Name: associatedDevices
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Device Name of device.
  • Field Name: device.[n]
  • Type: Array
Phone Profiles
  • Field Name: phoneProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Profile Name
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Line Appearance Association For Presences Applicable for Controlled Devices
  • Field Name: lineAppearanceAssociationForPresences
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Appearance Association For Presence
  • Field Name: lineAppearanceAssociationForPresence.[n]
  • Type: Array
Laap Product Type
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapProductType
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Associate
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapAssociate
  • Type: String
  • Cardinality: [0..1]
Laap Device Name
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDeviceName
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Partition
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapPartition
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Directory
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDirectory
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Description
  • Field Name: CUCM User.CUCMUser.[n].lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDescription
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Extensions Info These tags are for Quick User/Phone Add page
  • Field Name: extensionsInfo
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Extension These tags are for Quick User/Phone Add page
  • Field Name: extension.[n]
  • Type: Array
Pattern *
  • Field Name: CUCM User.CUCMUser.[n].extensionsInfo.extension.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Partition
  • Field Name: CUCM User.CUCMUser.[n].extensionsInfo.extension.[n].partition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Line Primary Uri
  • Field Name: CUCM User.CUCMUser.[n].extensionsInfo.extension.[n].linePrimaryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Sort Order
  • Field Name: CUCM User.CUCMUser.[n].extensionsInfo.extension.[n].sortOrder
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Route Partition
  • Field Name: CUCM User.CUCMUser.[n].extensionsInfo.extension.[n].routePartition
  • Type: String
  • Cardinality: [0..1]
Convert LDAP Synchronized User to Local User This check box appears for LDAP synchronized end users. Check this check box then save changes to convert an LDAP synchronized user to a local user.
  • Field Name: CUCM User.CUCMUser.[n].convertUserAccount
  • Type: String
  • Cardinality: [0..1]
Primary Extension Only DNs associated with the associatedDevices of the User can be used as primary extension.
  • Field Name: primaryExtension
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pattern * DN or Pattern
  • Field Name: CUCM User.CUCMUser.[n].primaryExtension.pattern
  • Type: String
  • Target: device/cucm/Line
  • Target attr: pattern
  • Cardinality: [1..1]
  • MaxLength: 255
  • Format: uri
Route Partition Name * Route Partition to which the DN is associated.
  • Field Name: CUCM User.CUCMUser.[n].primaryExtension.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • MaxLength: 50
  • Format: uri
Associated Groups
  • Field Name: associatedGroups
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
User Group
  • Field Name: userGroup.[n]
  • Type: Array
Groups * Name of User Group
  • Field Name: CUCM User.CUCMUser.[n].associatedGroups.userGroup.[n].name
  • Type: String
  • Target: device/cucm/UserGroup
  • Target attr: name
  • Cardinality: [1..1]
  • MaxLength: 100
  • Format: uri
User Roles
  • Field Name: userRoles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Roles READ ONLY: Name of the User Role associated with the user group will be taken.
  • Field Name: userRole.[n]
  • Type: Array
Enable Mobile Voice Access Check this check box to allow the user to access the Mobile Voice Access integrated voice response (IVR) system to initiate Cisco Unified Mobility calls and activate or deactivate Cisco Unified Mobility capabilities.
  • Field Name: CUCM User.CUCMUser.[n].enableMobileVoiceAccess
  • Type: Boolean
  • Cardinality: [0..1]
User Identity Value should be of of the format user@domain
  • Field Name: CUCM User.CUCMUser.[n].userIdentity
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ldap Directory Name
  • Field Name: CUCM User.CUCMUser.[n].ldapDirectoryName
  • Type: ["String", "Null"]
  • Target: device/cucm/LdapDirectory
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri