[Index]

Model: relation/HcsUserREL

Users

Use this procedure to manually create a user.

Procedure

  1. Log in as the administrator at the hierarchy node where you want to create the user.
  2. Choose User Management > Users.
  3. Click Add.
  4. At a minimum, complete the following fields:
Fields Description
Username Sign-in username. This field is mandatory.
Entitlement Profile Choose the entitlement profile that specifies which devices and services the user is entitled to.
Role Choose the user's role. This field is mandatory.
Language

Choose the user's language.

Note:

If no language is selected, the language is inherited from the nearest hierarchy node (at or above the user) that has a default language configured. If no default language is configured anywhere in the hierarchy at or above the user, the user's language is English.

Note:

If a language is manually set for a user, that language remains unchanged even if the user is moved to a new place in the hierarchy. However, if the language is inherited, then the user's language changes when the user is moved to a hierarchy node that has a different default language.
Surname User's family name. This field is mandatory.
Email Address User email address.
  1. Click Save. The user is created.

Note

If SSO is enabled for the hierarchy node where the user is added, the corresponding SSO user is created.

Note

IdPs are not configured at the site hierarchy node. Therefore, you can enable SSO for a user created at the site level only by performing these steps. Choose Single Sign On > SSO User, click Add, and choose the IdP that can authenticate the user.

Model Details

Title Description Details
Username * Login in username.
  • Field Name: username
  • Type: String
  • MaxLength: 1024
Building Building name or number.
  • Field Name: buildingName.[n]
  • Type: Array
User Type
  • Field Name: userType
  • Type: String
  • Choices: ["CUCM Local", "VOSS Only", "CUCM-LDAP Synced", "VOSS-LDAP Synced", "Unknown"]
Country Country name.
  • Field Name: c
  • Type: String
  • MaxLength: 1024
Department Department names and numbers.
  • Field Name: departmentNumber.[n]
  • Type: Array
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: directoryUri
  • Type: String
Display Name
  • Field Name: displayName
  • Type: String
  • MaxLength: 1024
Employee Number
  • Field Name: employeeNumber
  • Type: String
  • MaxLength: 1024
Employee Type
  • Field Name: employeeType.[n]
  • Type: Array
Facsimile Telephone Number
  • Field Name: facsimileTelephoneNumber.[n]
  • Type: Array
Given Name Contains strings that are part of the person's name excluding surnames.
  • Field Name: givenName.[n]
  • Type: Array
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: homePhone.[n]
  • Type: Array
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: ipPhone.[n]
  • Type: Array
Jabber ID
  • Field Name: jabberID
  • Type: String
  • MaxLength: 1024
City Contains the name of a person's locality.
  • Field Name: l
  • Type: String
  • MaxLength: 1024
Email Address
  • Field Name: mail.[n]
  • Type: Array
Manager
  • Field Name: manager.[n]
  • Type: Array
Member Of The user can be a member of a variety of groups.
  • Field Name: memberOf.[n]
  • Type: Array
Mobile
  • Field Name: mobile.[n]
  • Type: Array
Organization The name of the person's organization.
  • Field Name: o
  • Type: String
  • MaxLength: 1024
Object Class
  • Field Name: objectClass.[n]
  • Type: Array
Other Mailbox
  • Field Name: otherMailbox.[n]
  • Type: Array
Organizational Unit The name of the person's organization unit.
  • Field Name: ou.[n]
  • Type: Array
Photo URL
  • Field Name: photoURL
  • Type: String
  • MaxLength: 1024
Physical Delivery Office Name
  • Field Name: physicalDeliveryOfficeName.[n]
  • Type: Array
Postal Code Contains codes used by a Postal Service to identify postal service zones.
  • Field Name: postalCode.[n]
  • Type: Array
Preferred Language
  • Field Name: preferredLanguage
  • Type: String
  • MaxLength: 1024
Surname Contains strings for the family names of a person.
  • Field Name: sn.[n]
  • Type: Array
State Contains full names of states or provinces.
  • Field Name: st.[n]
  • Type: Array
Street Contains site information from a postal address.
  • Field Name: street.[n]
  • Type: Array
Telephone Number
  • Field Name: telephoneNumber.[n]
  • Type: Array
Timezone
  • Field Name: timezone
  • Type: String
  • MaxLength: 1024
Title
  • Field Name: title.[n]
  • Type: Array
Userid Contains computer login names for the user.
  • Field Name: uid.[n]
  • Type: Array
Unverified Mail Box
  • Field Name: unverifiedMailBox.[n]
  • Type: Array
Custom String 1 Custom String
  • Field Name: customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: customString5
  • Type: String
Custom List of Strings 1 Custom List of Strings
  • Field Name: customListOfStrings1.[n]
  • Type: Array
Custom List of Strings 2 Custom List of Strings
  • Field Name: customListOfStrings2.[n]
  • Type: Array
Custom List of Strings 3 Custom List of Strings
  • Field Name: customListOfStrings3.[n]
  • Type: Array
Custom List of Strings 4 Custom List of Strings
  • Field Name: customListOfStrings4.[n]
  • Type: Array
Custom List of Strings 5 Custom List of Strings
  • Field Name: customListOfStrings5.[n]
  • Type: Array
Rbac
  • Field Name: rbac
  • Type: Object
User Name * The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: rbac.username
  • Type: String
Email Address The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: rbac.email
  • Type: String
First Name The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: rbac.first_name
  • Type: String
Last Name The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: rbac.last_name
  • Type: String
Password The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.
  • Field Name: rbac.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: rbac.role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • Format: uri
Language The preferred language for this user. Default: en-us
  • Field Name: rbac.language
  • Type: String
  • Target: data/Language
  • Target attr: lcid
  • Default: en-us
  • Format: uri
Set by Default Language Indicate if the user's language is set by language default in the hierarchy.
  • Field Name: rbac.set_language
  • Type: Boolean
Account Information Additional account information for the given user.
  • Field Name: account_information
  • Type: Object
Change Password on Next Login Indicates if the user must be forced to change their password the next time that login.
  • Field Name: rbac.account_information.change_password_on_login
  • Type: Boolean
Locked Indicates if the account has been locked to prevent the user from logging in.
  • Field Name: rbac.account_information.locked
  • Type: Boolean
Disabled Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.
  • Field Name: rbac.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: rbac.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: rbac.account_information.credential_policy
  • Type: String
  • Target: data/CredentialPolicy
  • Target attr: name
  • Format: uri
Time Locked Due to Failed Login Attempts The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.
  • Field Name: rbac.account_information.failed_login_lock_date
  • Type: String
  • Format: date-time
Time of Last Password Change The time when the password was last changed.
  • Field Name: rbac.account_information.password_last_change_time
  • Type: String
  • Format: date-time
Time of Last Password Change By User The time when the password was last changed by the user.
  • Field Name: rbac.account_information.password_last_change_time_by_user
  • Type: String
  • Format: date-time
Time of Last Successful Login The time the user last logged in successfully.
  • Field Name: rbac.account_information.last_login_time
  • Type: String
  • Format: date-time
Number of Failed Login Attempts Since Last Successful Login The total number of failed login attempts since last successful login. Default: 0
  • Field Name: rbac.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: rbac.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: rbac.account_information.security_questions.[n].answer
  • Type: String
  • MaxLength: 128
Used Passwords List of passwords that have been used by user.
  • Field Name: used_passwords.[n]
  • Type: Array
Password Used password
  • Field Name: rbac.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: rbac.account_information.used_passwords.[n].time_created
  • Type: String
Ps
  • Field Name: ps
  • Type: Object
Username *
  • Field Name: ps.username
  • Type: String
  • MaxLength: 1024
LDAP Server
  • Field Name: ps.ldap_server
  • Type: String
  • Target: data/Ldap
  • MaxLength: 1024
  • Format: uri
LDAP Device User PKID
  • Field Name: ps.ldap_device_user_pkid
  • Type: String
  • MaxLength: 1024
CUCM Server
  • Field Name: ps.cucm_server
  • Type: String
  • Target: data/CallManager
  • MaxLength: 1024
  • Format: uri
CUCM Device User PKID
  • Field Name: ps.cucm_device_user_pkid
  • Type: String
  • MaxLength: 1024
Synced To
  • Field Name: ps.sync_to_hn
  • Type: String
  • Target: data/HierarchyNode
  • MaxLength: 1024
  • Format: uri
Entitlement Profile
  • Field Name: ps.entitlement_profile
  • Type: String
  • Target: data/HcsEntitlementProfileDAT
  • MaxLength: 1024
  • Format: uri
Ldap
  • Field Name: ldap
  • Type: Object
LDAP Username * The login attribute of the associated LDAP device model instance
  • Field Name: ldap.ldap_username
  • Type: String
Data Username The data username that is mapped to the associated LDAP device model instance.
  • Field Name: ldap.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: ldap.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: 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: ssoUser.[n].sso_username
  • Type: String
Data Username The data username that is mapped to the associated SSO authenticated user.
  • Field Name: ssoUser.[n].data_username
  • Type: String
  • Target: data/User
  • Target attr: username
  • Format: uri
Sdr User
  • Field Name: sdrUser.[n]
  • Type: Array
  • Cardinality: [0..1]
id
  • Field Name: sdrUser.[n].id
  • Type: String
  • MaxLength: 1024
User Name *
  • Field Name: sdrUser.[n].userName
  • Type: String
  • MaxLength: 128
Identity Store UUID
  • Field Name: sdrUser.[n].identityStoreUUID
  • Type: String
  • MaxLength: 128
Description
  • Field Name: sdrUser.[n].description
  • Type: String
  • MaxLength: 128
Last Name
  • Field Name: sdrUser.[n].lastName
  • Type: String
  • MaxLength: 128
First Name
  • Field Name: sdrUser.[n].firstName
  • Type: String
  • MaxLength: 128
Display Name
  • Field Name: sdrUser.[n].displayName
  • Type: String
  • MaxLength: 128
Email Address
  • Field Name: sdrUser.[n].emailAddress
  • Type: String
  • MaxLength: 128
Telephone Number
  • Field Name: sdrUser.[n].telephoneNumber
  • Type: String
  • MaxLength: 128
Building
  • Field Name: sdrUser.[n].building
  • Type: String
  • MaxLength: 128
Street
  • Field Name: sdrUser.[n].street
  • Type: String
  • MaxLength: 128
City
  • Field Name: sdrUser.[n].city
  • Type: String
  • MaxLength: 128
State
  • Field Name: sdrUser.[n].state
  • Type: String
  • MaxLength: 128
Postal Code
  • Field Name: sdrUser.[n].postalCode
  • Type: String
  • MaxLength: 32
Country
  • Field Name: sdrUser.[n].country
  • Type: String
  • MaxLength: 128
CCDM Identity
  • Field Name: sdrUser.[n].cCDMIdentity
  • Type: String
  • MaxLength: 128
Type DMA Roles
  • Field Name: sdrUser.[n].typeDMARoles
  • Type: String
  • MaxLength: 1024
  • Choices: ["PROVIDER_ADMIN", "PROVIDER_OPERATOR", "RESELLER_ADMIN", "RESELLER_OPERATOR", "CUSTOMER_ADMIN", "CUSTOMER_OPERATOR", "PROVIDER_ADMIN_SA", "PROVIDER_OPERATOR_SA", "PROVIDER_ADMIN_FF", "PROVIDER_OPERATOR_FF", "RESELLER_ADMIN_SA", "RESELLER_OPERATOR_SA", "RESELLER_ADMIN_FF", "RESELLER_OPERATOR_FF", "CUSTOMER_ADMIN_SA", "CUSTOMER_OPERATOR_SA", "CUSTOMER_ADMIN_FF", "CUSTOMER_OPERATOR_FF"]
Directory Domain *
  • Field Name: sdrUser.[n].directoryDomain
  • Type: String
  • Target: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
Customer Location
  • Field Name: sdrUser.[n].customerLocation
  • Type: String
  • Target: data/HCSHcmfCustomerLocationDAT
  • MaxLength: 1024
  • Format: uri
Scope Org Unit
  • Field Name: sdrUser.[n].scopeOrgUnit
  • Type: String
  • Target: data/HCSHcmfOrgUnitDAT
  • MaxLength: 1024
  • Format: uri
Bk Directory Domain Name
  • Field Name: sdrUser.[n].bkDirectoryDomain_name
  • Type: String
  • Target: data/HCSHcmfDirectoryDomainDAT
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
API reference for relation/HcsUserREL