User document (Data API 18.3)

Document representing a user.

Property Type Constraints Description
disabled boolean   Flag whether the user is disabled.
email String mandatory=true, maxLength=256, nullable=false The email address.
first_name String maxLength=256 The first name.
last_login_date LocalDate   Last login of the user.
last_name String mandatory=true, maxLength=256, nullable=false The last name.
locked boolean   Flag whether the user is locked.
login String maxLength=256 The user login.
password String   The password. This attribute is only used to set the password upon user creation.
password_expiration_date DateTime   The user password expiration time
password_modification_date DateTime   The time, where the password was last modified
preferred_data_locale String   The effective preferred data locale of the user. A locale is only considered if the user has at least read permission on the locale.
preferred_ui_locale String   The preferred UI locale of the user.
roles [String]   List of role ids the user is assigned to.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.