[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%240Lvyr9JrvVpkbfAo%243hxgrjU/ZJNe2mIOujf%2BwZ1yK1XJhHiXYbTgmnWJIZDBnSav/kiCDwRqsLYlTKKZ8Q/kDKWvUITIC7D%2BthCGRjomYfsVXmIH77ncKTVU6GHLjvC/UJ/Z7IvMlbAg/D4o57xs99GO7FZ6jpiXiiaDXzQVdbb1VGJN4e7XoDGJWLR1GckNtTCP8LQssovaxREF6Unds3ByUQImS7kDcVOvLkh9Q8qgqpQX%2B90fTI0%2BrYLgXiPNPoO7EESQa0xhkAEFafCh8zJayz8QIpu7DJ70e7KqfwAWlTPM/djOTr6ZE0wPPjZfADT9DO8/pvWGGvTUUr9taREFZEb8Fqh81wEcaNQA3mLagUnLgPU%2B4cKE6biFs0Z0M1tEygljkwJWzHxH57srcXZZtwE4qU3InwIRIw20hJVPtusPiSo9Zb6tzAoQ5139Cp%2Bp1YJC%2BIDK1sUwPEsR3hxcsIfumnfXsxliajPpMUUu0N/IpPSq1msxJ5%2BB%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%242fyRmzIsARKgBjj6%24%2BTiJGgRy/Wj/xRde/Xd/hNKY1bMhBLynS475CI7OHrftIpwp3UqOb7MGEqOwDJylmiPh6Xd1DU6jQE11IwBiRFVkRDdjCPNOxH4%2BzykAmpsMd8mG4AT0yb9N8VZCx%2B1l083Y%2BP4GHjkf0OgOeu4322ViCuubtP45YDx8KJ12tK6PHwkeadDbVcPn0hQMK2RjcmUyR4YiSqZkGZCeop2DRXym1sgA91Yne8DithnA1sd%2BnwRNu1muMjfRS7JlyZKd9dVRGvUfImYFgFf2ZWqW9p8rj2hliugL3zYlpNeIroa/94tiebU/EYWLFvhH3oCT53PGykZhlDkEkTB3VhFAWZwImFBNKWoZeXZ/F289JXkVKWAvwBWpLGWmRR4/harkeg9BMyESkzlzSrHg7yxL/4HwYCH4DXsaA/L9T0uy/THbWP7q8tCZmQoM214lJjAcdcvkC3EbxyuR11LhHUXBbSkriybj0Dvo61wqfc6lhlJrdmhlis1fiHSF4s9UdMLApUSUVbo%3D%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%24HFWLhhIKTaYeV8oL%24Z%2BBUpxLMVUrmIOlo4duDXZWyMBhC5T6u7O0U8EEst/Kvp4HNjDvsMR5M6POGyD6jWa4LC5A6HAkxAxpBEQmBJfc60TaUQFKpcJ1rzB7J2qyJuDwpud62KuwLZk5OCEkvPz5aX/GVoacTvJfJPyaq4PuiVwov2e/Ze9HU8T/VW8GSkDskgoMWQOxQ0iw9kAjOo8GHOzyhxeNpCx4rWbZpakhZQQvz9pGcBgYETlT3TlcipjHJ8PmcaWHOzaQMMlkkGPfOIDCbp3y9qOK%2BsKftaQlBDnZYKsXqx5uNUDjcKvhXv9/BEWzdQLJgDIKUEs9xwkzNNqdqJkeHGBQtcpfIdJQcTpNyIHW/tIouvAd2r2OIgiu3s%2BHq0RUd4e9zhLPQnxj2IfDK%2BujPvq0mHw6cWfY7LxeGaTzJxtWCsTGZN7LVhWiePWEMHuSFvJMVlWVBf6lP1Ed1FxXtkf3FbG5gBW%2BPCPOp2Q%3D%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%24jwbtQDkVuOHxAgMk%24MC%2BEtU/YAOGYR7Je3PdLal%2BPZP07QI7iOIxIbaOTHa/6BkWr4phg1aLnd0fafGJGXCAdJJjaAQ5mmASEPituEp7R8fynIN9VV77ZyRSKyOd3m7n%2Bseox%2B8irwokSyCGuBm7Rq0luJ/HzWH1Etk4TC4pS1pQRLnlkZIdf2TV8A0VXBhF2obJ9ImIEOnh7jM6dKH59E72o2cXMrRckfhVxUBYGLvVJ76wAa8shTn3YDaHs5ZsqRj%2BvdwnULqePqAJXfT%2B2sQjxhTY4WwG/T9t2ceBeSlEGyYR%2B/Y/qsIOJOyzEvMKoKiUqloZAf63SDHBdlbizwLDfAGq3sZnYMwOz6ZtLcK%2Bjf87eQPGT15E8KwjX0nbfbhif00w4qRrK04%2BIx2CC9gqejLJUbZ8a%2BQMo7nP5kRVnCudLKj7TEEq/JJVOQMAFm8Dk2Qe565JjewREXAgU6Duxc1EoZdp02q1QDVD3KV9ks4Ho6Uaqd5R4zPMun6VfEA2q3XOVJE4k%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