[Index]

Model: relation/HcsAdminUserREL

Data User

Default local VOSS-4-UC administrators are created when provider, reseller, customer, and site hierarchy nodes are established. Use this procedure to modify or create more local administrators or operators. Also use this procedure to create administrators for intermediate nodes.

An administrator for a particular hierarchy level can create or modify the administrators and operators at that hierarchy level and any level below. For example, a Customer XYZ administrator can create other Customer XYZ administrators and site administrators for Customer XYZ.

Procedure

  1. Log in as an administrator.
  2. To create or modify an administrator or operator at a level below your current level, set the hierarchy path at the top of the window. If you have signed in as provider administrator, and want to create a customer administrator, set the hierarchy path to the customer for which you want to create the administrator.
  3. Choose User Management > Local Admins.
  4. At a minimum, complete these fields:
Fields Description
Username Sign-in username. This field is mandatory.
Email Address User email address.
Role

Choose the administrator's role. This field is mandatory.

  • For a provider, reseller, customer, or site administrator or operator, the available roles are limited to those applicable to the hierarchy level.
  • For an intermediate node administrator or operator, the available roles are limited to those associated with the nearest non-intermediate node above the intermediate node in the hierarchy.
Password Set the password. This field is mandatory.
Language

Choose the administrator's language. Note:

If no language is chosen, the language is inherited from the nearest hierarchy node (at or above the administrator) that has a default language configured. If no default language is configured anywhere in the hierarchy at or above the administrator, the administrator's language is English.
  1. To modify an existing administrator or operator, click the administrator or operator.
    1. Modify the appropriate settings for the administrator or operator.
    2. Click Save.

Model Details

Title Description Details
HcsUsername *
  • Field Name: hcsUname
  • Type: String
  • MaxLength: 1024
Admin User
  • Field Name: AdminUser
  • Type: Object
User Name * The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.last_name
  • Type: String
Password The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.
  • Field Name: AdminUser.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: AdminUser.role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • Format: uri
Language The preferred language for this user. Default: en-us
  • Field Name: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: AdminUser.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.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: AdminUser.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: AdminUser.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: AdminUser.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: AdminUser.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: AdminUser.account_information.used_passwords.[n].time_created
  • Type: String
API reference for relation/HcsAdminUserREL