[Index]

Model: relation/SystemUser

User Relation including data, SSO and LDAP users.

Model Details: relation/SystemUser

Title Description Details
User Details Group Assigned by FDP
  • Field Name: User Details
  • Type: Object
User Name * User's Username.
  • Field Name: User Details.username
  • Type: String
First Name The User first name.
  • Field Name: User Details.first_name
  • Type: String
Last Name The User last name.
  • Field Name: User Details.last_name
  • Type: String
Email Address The User email address.
  • Field Name: User Details.email
  • Type: String
Password The User password.
  • 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: /api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%241Ax6MoFyhpsJpu4J%24hfYpjHG3oHoPEuv53%2BFlgduZJHSKt0WbSC6ixfAR1Sc2LgKuM6ennby2XcgnoD50lIWCwSUIQS0f7TESELt%2BdPFTutzZyhXZD2mVGK/WIAyPdcYvtpYCSskyQcPpmlN3Ff1eVauxzJ8XzzADC40PNj7vxb0/ePph43%2BybFMc8cRFia0mYUHYj/hfGzD3le2bDJV7e6P1aLuerEIlGbP627JTcYwQ0m/5kDfb5oKqQ42upP2YG%2BP7MRhHYE2Kf2i41EdOIS2X0YDNcoQAQ7LFpdBD0GdK2xeTVBx/2NDLCOOL9YqCqjueN24gInsup/I2W9pkNANN%2BV86NKZFL%2BjckYyA0hyoTWAF7UBGa8CWNdWr7A%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/Role
  • Format: uri
  • Choices: []
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: /api/data/SsoIdentityProvider/choices/?field=entity_id&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24aROeqfzDNYstcmGr%240gw7xTso4CKIGFv8tL0UDqliyxNdwHuJRabgsSshtK7kaTeH5xSI32a3trH/nsTUzIZrUE8R0VboRngmNvHaovHCIpqJuUci1KB6d4fGipf7UyzmBAWILYkmn/MxmpQ7NX2qdHdY%2BPyicRC/2fWwv8f9Rh6zeeUm5aij8JhHwSFjM4B/f01N2e3BnSWuZRZaUq5i6HsqjwpOfE4vR96kKYyiTkdMz8wA2hPakoZbkC%2B2Atk30gkxmyQ6VYR%2BVlKbRUaxwNsvmrmTg0K0ecrd31l09d5dOAR8aljsbczR8X53S0aavS3%2BL%2BEoKr4S0h9XbVR2hjSW5tb%2BLbGwf595gzGJTkcAe5G2%2BDlexOYuYRr6VQo0ntKjuXaFLXEXobEYTz%2Bh83jN%24%3D%3D
  • Target attr: entity_id
  • Target Model Type: data/SsoIdentityProvider
  • Format: uri
  • Choices: []
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: /api/data/Ldap/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24Mzz330QuK14vC3Cp%247%2BFcLaQRoiKEAtRG4qw7NummNOVnPk/fRJfuXJ49XPskCIsLbjgb6MRyAbGhJmOenKJ7fh1x/kdNcu/mrEcQnWPtRPM%2BXCRnrTgJzcAW/fm/ArbDRgLGA1eL7djSiqCUMRFbF3j49s%2Bk04zWqQ6TAAOSoKk%2BsRMwyr2di0JWMlafA7HYiyroSW/xeVty0DDB3%2BRX/tdlQ5yJD3gOCr00hABgPQuAxnGQ/FND91ua9pcJUbRt3HZfmfTg0QXp7Pq%2BX%2BDwMzPuGOTGOUWmF8arWDCczY9zRisd/uIhzc16YY3zwbNkHc2hkav4Jtpg/uCA6VQRH9MetA2uVeXwqVHcz1UrkP6enII%3D%24%3D%3D
  • Target Model Type: data/Ldap
  • Format: uri
  • Choices: []
User Authentication Method The type of authorization that our user would be using. Typically this would be choices between a Standard VOSS Automate 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 Automate 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: /api/data/CredentialPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24kMCJ6PG1HJLmQ8c9%24TRkFcWKy7mpyQqokdpAW0EnPZ3aNiJGi%2BwtRufMJWqqkq3n%2B70lEMyaGPQ0o94o15/gJDxrQsd/m%2BLIGKFuUZJ6VUREvmr7SSNV2nKWRbkP7URkAgV8abAeY6MuXKc2pPjSABShxhD3imV6szDzxwK%2Brtd9EdIGykbwpMtHgHeNsSxI%2BqfDMlgEa8PsVmVGwIYq0Df4%2Bv5TRIuAn7fLFg%2BP89HwfXnCNDBuv1GrK8q1UvUKhA8/9wVl49%2BxnLR14wCnD8bARjl1HyFo6UqLKB4YFYFz5O1Z3SDlFvmG/6KxBWeOBoXMe1tjnv%2BOd6Gciyb8CYQfaC7V4BcrCD%2BgYdEcv992Ha2%2B/jRHV9EAXJndTojCi19m4RNUJcN9DSg%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: data/CredentialPolicy
  • Format: uri
  • Choices: []
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