[Index]

Model: device/cucm/User

Model Details

Title Description Details
Confirm MLPP Password Confirm the MLPP password. Note    To confirm that you entered the MLPP Password correctly, re-enter the password in this field.
  • Field Name: mlppPassword
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
  • MaxLength: 20
  • Pattern: ^[0-9]{4,20}$
Associated Pc This required field applies for Cisco IP Softphone users.
  • Field Name: associatedPc
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
MLPP Precedence Authorization Level Set the MLPP Precedence Authorization Level. The following precedence levels indicate the priority level that is associated with a call: 0: Flash Override (highest) 1: Flash 2: Immediate 3: Priority 4: Routine (lowest) You can set the Precedence Authorization Level to any standard precedence level from Routine to Executive Override. Calls of equal or lower precedence are authorized to be originated by the user. Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
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: directoryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 254
  • Pattern: ^[^@]{1,47}@[^@]+$
Confirm PIN Enter the PIN again.
  • Field Name: pin
  • Type: String
  • Is Password: True
  • 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: imAndPresenceEnable
  • Type: Boolean
  • Cardinality: [0..1]
Calendar Presence
  • Field Name: calendarPresence
  • Type: Boolean
  • 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
Manager Enter the user ID of the end user manager ID. Tip    The manager user ID that you enter does not have to exist in the same cluster as the end user; therefore, Unified CM does not require that you enter a user ID that already exists in the database.
  • Field Name: manager
  • Type: ["String", "Null"]
  • 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: convertUserAccount
  • Type: String
  • Cardinality: [0..1]
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: ipccExtension
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Home Cluster Check this check box if the end user is homed to this cluster. The end user should only be homed to one cluster within the enterprise. Note    After an upgrade to Unified Communications Manager Release 10.0(1), when new users are synced from LDAP, the home cluster is not enabled. You must modify your existing LDAP synchronization agreement and add a Feature Group Template which has the home cluster enabled. Default: True
  • Field Name: homeCluster
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Maximum Wait Time for Desk Pickup Enter the maximum time in milliseconds that is permitted to pass before the user must pick up a call that is transferred from the mobile phone to desktop phone. Default: 10000
  • Field Name: maxDeskPickupWaitTime
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 10000
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: 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: primaryExtension.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • MaxLength: 50
  • Format: uri
Customer Name This tag should only be used by Hosted Collaboration Solution Shared Architecture deployments.
  • Field Name: customerName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Title
  • Field Name: title
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Middle Name Enter the end user middle name.
  • Field Name: middleName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pin Credentials Not Applicable for add. These groups get automatically added once an user is added.
  • Field Name: pinCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pin Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: pinCredentials.pinResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Locked By Administrator
  • Field Name: pinCredentials.pinCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Admin Lockout
  • Field Name: pinCredentials.pinCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pin Cred Does Not Expire
  • Field Name: pinCredentials.pinCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Policy Name
  • Field Name: pinCredentials.pinCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pin Cred User Cant Change
  • Field Name: pinCredentials.pinCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred Time Changed
  • Field Name: pinCredentials.pinCredTimeChanged
  • Type: Boolean
  • Cardinality: [0..1]
Pin Cred User Must Change
  • Field Name: pinCredentials.pinCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Attendees Access Code Set the Attendees Access Code for a secure conference call. The access code can be modified in the Self Care Portal. For more information on how to modify the access code, see the Cisco Unified Communications Self Care Portal User Guide.
  • Field Name: attendeesAccessCode
  • Type: String
  • Cardinality: [0..1]
Home Number Enter the end user home number. You may use the following special characters: (,), and -.
  • Field Name: homeNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
User Identity Value should be of of the format user@domain
  • Field Name: userIdentity
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ipcc Route Partition Applicable for Controlled Devices so this tag is appropriate for Get/UpdateUser APIs with ipccExtension tag only.
  • Field Name: ipccRoutePartition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Zero Hop If zeroHop value is false pin will be synchronized with UCxN, if synchronization is enabled for Unity Connection server and if zeroHop is true pin will not be synchronized with UCxN. This tage is supported only for updateUser api
  • Field Name: zeroHop
  • Type: Boolean
  • Cardinality: [0..1]
Department Enter the end user department information (for example, the department number or name).
  • Field Name: department
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
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: enableEmcc
  • Type: Boolean
  • Cardinality: [0..1]
Confirm Digest Credentials To confirm that you entered the digest credentials correctly, re-enter the credentials in this field.
  • Field Name: digestCredentials
  • Type: ["String", "Null"]
  • Is Password: True
  • Cardinality: [0..1]
Enable User To Host Conference Now Check this check box to allow End User to host Conference Now.
  • Field Name: enableUserToHostConferenceNow
  • Type: Boolean
  • Cardinality: [0..1]
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: 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
Self Service The Meeting Number is generated automatically when the Self-Service User ID field is configured.
  • Field Name: selfService
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
  • Pattern: ^[0-9*#]{0,27}$
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: enableMobility
  • Type: Boolean
  • Cardinality: [0..1]
Phone Profiles
  • Field Name: phoneProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Profile Name
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
Password Credentials Not Applicable for Add. Credential configuration for password.
  • Field Name: passwordCredentials
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Pwd Cred User Must Change
  • Field Name: passwordCredentials.pwdCredUserMustChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred User Cant Change
  • Field Name: passwordCredentials.pwdCredUserCantChange
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Time Changed
  • Field Name: passwordCredentials.pwdCredTimeChanged
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Time Admin Lockout
  • Field Name: passwordCredentials.pwdCredTimeAdminLockout
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Pwd Cred Policy Name
  • Field Name: passwordCredentials.pwdCredPolicyName
  • Type: String
  • Cardinality: [0..1]
Pwd Cred Locked By Administrator
  • Field Name: passwordCredentials.pwdCredLockedByAdministrator
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Reset Hack Count The tag will be ignored in add, while update you can reset the hack count.
  • Field Name: passwordCredentials.pwdResetHackCount
  • Type: Boolean
  • Cardinality: [0..1]
Pwd Cred Does Not Expire
  • Field Name: passwordCredentials.pwdCredDoesNotExpire
  • Type: Boolean
  • Cardinality: [0..1]
MLPP User ID This pane displays the Instance ID from the CAPF Profile that you configured for this user. To view or update the profile, double-click the Instance ID or click the Instance ID to highlight it; then, click View Details. The End User CAPF Profile Configuration window displays with the current settings. Note    The MLPP User Identification number must comprise 6 - 20 numeric characters. For information on how to configure the End User CAPF Profile, see the Cisco Unified Communications Manager Security Guide.
  • Field Name: numericUserId
  • Type: String
  • Cardinality: [0..1]
  • Pattern: ^[0-9]{6,20}$
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: subscribeCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
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: userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Associated Remote Destination Profiles Read-Only.These groups automatically get added once the user is associated with a Remote Destination Profile.
  • Field Name: associatedRemoteDestinationProfiles
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Remote Destination Profiles This field lists the remote destination profiles that were created for this user. To view the details of a particular remote destination profile, choose a remote destination profile in the list and click the View Details link.
  • Field Name: remoteDestinationProfile.[n]
  • Type: Array
Allow Control of Device from CTI If this check box is checked, when the user logs in to a device, the AllowCTIControlFlag device property becomes active, which allows control of the device from CTI applications. Until the user logs in to a device, this setting has no effect. Note    The Allow Control of Device from CTI setting in the end user configuration overrides the AllowCTIControlFlag device property of the device to which the user logs in. Default: True
  • Field Name: enableCti
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Mailid Enter the end user e-mail address.
  • Field Name: mailid
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Em Max Login Time
  • Field Name: emMaxLoginTime
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
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: enableMobileVoiceAccess
  • Type: Boolean
  • Cardinality: [0..1]
Name Dialing
  • Field Name: nameDialing
  • Type: String
  • Cardinality: [0..1]
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: presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Confirm Password This field does not display for LDAP Synchronized users if LDAP Authentication is enabled. Enter the end user password again.
  • Field Name: password
  • Type: String
  • Is Password: True
  • Cardinality: [0..1]
Default Profile From the drop-down list box, choose a default extension mobility profile for this end user.
  • Field Name: defaultProfile
  • Type: String
  • Cardinality: [0..1]
Telephone Number Enter the end user work number. You may use the following special characters: (, ), and -.
  • Field Name: telephoneNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Mobile Number Enter the end user mobile number. You may use the following special characters: (,), and -.
  • Field Name: mobileNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Display Name This field appears for local end users as well as LDAP synchronized end users. You can specify a display name for the local end users. For LDAP synchronized end users, this field appears if Microsoft Active Directory is used as the corporate directory. It displays the display name of the end user as specified in Microsoft Active Directory. Note    This field is supported on Administrative XML (AXL) and Bulk Administration Tool (BAT).
  • Field Name: displayName
  • Type: String
  • Cardinality: [0..1]
First Name Enter the end user first name.
  • Field Name: firstName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Last Name * Enter the end user last name.
  • Field Name: lastName
  • Type: String
  • Cardinality: [1..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: serviceProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/ServiceProfile
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Garbage Collection Status Garbage Collection Status
  • Field Name: status
  • Type: Integer
  • 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: userid
  • Type: String
  • Cardinality: [1..1]
Cti Controlled Device Profiles
  • Field Name: ctiControlledDeviceProfiles
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Controlled Profiles This drop-down list box displays the CTI-controlled profiles that are available for association with an end user who is configured for CTI.
  • Field Name: profileName.[n]
  • Type: Array
  • Cardinality: [1..n]
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: extensionsInfo.extension.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Partition
  • Field Name: extensionsInfo.extension.[n].partition
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Line Primary Uri
  • Field Name: extensionsInfo.extension.[n].linePrimaryUri
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Sort Order
  • Field Name: extensionsInfo.extension.[n].sortOrder
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Route Partition
  • Field Name: extensionsInfo.extension.[n].routePartition
  • Type: String
  • Cardinality: [0..1]
User Profile
  • Field Name: userProfile
  • Type: ["String", "Null"]
  • Target: device/cucm/UserProfileProvision
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Ldap Directory Name
  • Field Name: ldapDirectoryName
  • Type: ["String", "Null"]
  • Target: device/cucm/LdapDirectory
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Remote Destination Limit Enter the maximum number of phones to which the user is permitted to transfer calls from the desktop phone. Default: 4
  • Field Name: remoteDestinationLimit
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 4
Custom User Fields
  • Field Name: customUserFields
  • Type: Object
  • Cardinality: [0..1]
Custom User Field This Tag is valid only for GetUser
  • Field Name: customUserField.[n]
  • Type: Array
  • Cardinality: [0..5]
Name
  • Field Name: customUserFields.customUserField.[n].name
  • Type: String
  • Cardinality: [0..1]
Value
  • Field Name: customUserFields.customUserField.[n].value
  • Type: String
  • Cardinality: [0..1]
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: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapProductType
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Associate
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapAssociate
  • Type: String
  • Cardinality: [0..1]
Laap Device Name
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDeviceName
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Partition
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapPartition
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Directory
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDirectory
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Laap Description
  • Field Name: lineAppearanceAssociationForPresences.lineAppearanceAssociationForPresence.[n].laapDescription
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Pager Number Enter the end user pager number. You may use the following special characters: (,), and -.
  • Field Name: pagerNumber
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
API reference for device/cucm/User