[Index]

Model: relation/SystemUser

User Relation including data, SSO and LDAP users.

Model Details

Title Description Details
User Details Group Assigned by FDP
  • Field Name: User Details
  • Type: Object
User Name * The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Details.username
  • 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: User Details.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: User Details.last_name
  • Type: String
Email Address The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Details.email
  • Type: String
Password The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.
  • Field Name: User Details.password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • Pattern: .{8,}
Role * The role to which the user belongs. See: Role.
  • Field Name: User Details.role
  • Type: String
  • Target: data/Role
  • Target attr: name
  • 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: User Details.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: User Details.SSOUser.[n].sso_username
  • 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: User Details.LDAPUser.[n].ldap_username
  • Type: String
LDAP Server A reference to the LDAP server which this user must authenticate against.
  • Field Name: User Details.LDAPUser.[n].ldap_server
  • Type: String
  • Target: data/Ldap
  • Format: uri
User Authentication Method The type of authorization that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user. Default: standard
  • Field Name: User Details.auth_method
  • Type: String
  • Default: standard
  • Choices: ["Standard", "LDAP", "SSO"]
Auth Method
  • Field Name: AuthMethod
  • Type: Object
User Authentication Method The type of authorization that our user would be using. Typically this would be choices between a Standard VOSS 4 UC user, an LDAP user or an SSO user. Default: standard
  • Field Name: User Details.AuthMethod.auth_method
  • Type: String
  • Default: standard
  • Choices: ["Standard", "LDAP", "SSO"]
Account Information Group Assigned by FDP
  • Field Name: Account Information
  • Type: Object
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: Account Information.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: Account Information.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: Account Information.account_information.disabled
  • Type: Boolean
Reason for Disabled A description of why the account is disabled.
  • Field Name: Account Information.account_information.reason_for_disabled
  • Type: String
Credential Policy Specifies the policy with the rules used to govern this user's credentials.
  • Field Name: Account Information.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: Account Information.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: Account Information.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: Account Information.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: Account Information.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: Account Information.account_information.num_of_failed_login_attempts
  • Type: Integer
  • Default: 0
Security Questions
  • Field Name: security_questions.[n]
  • Type: Array
Question *
  • Field Name: Account Information.account_information.security_questions.[n].question
  • Type: String
  • MaxLength: 128
Answer *
  • Field Name: Account Information.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: Account Information.account_information.used_passwords.[n].password
  • Type: String
Time Created Time when password was created.
  • Field Name: Account Information.account_information.used_passwords.[n].time_created
  • Type: String
API reference for relation/SystemUser