# ApiUser Data Model

This is the model for user information in the API prior to v18. Post v18, please refer to ApiUser2.java.

Note that any method that returns user information will not contain any password information. The password property is only used when creating or updating users.

Properties
name | data type | description
--- | --- | ---
name | string | The username, which is unique within a Cloudera Manager installation.
password | string | Returns the user password. Passwords are not returned when querying user information, so this property will always be empty when reading information from a server.

roles

array of string

A list of roles this user belongs to.

In Cloudera Express, possible values are:

- ROLE_ADMIN
- ROLE_USER

In Cloudera Enterprise Datahub Edition, additional possible values are:

- ROLE_LIMITED: Added in Cloudera Manager 5.0
- ROLE_OPERATOR: Added in Cloudera Manager 5.1
- ROLE_CONFIGURATOR: Added in Cloudera Manager 5.1
- ROLE_CLUSTER_ADMIN: Added in Cloudera Manager 5.2
- ROLE_BDR_ADMIN: Added in Cloudera Manager 5.2
- ROLE_NAVIGATOR_ADMIN: Added in Cloudera Manager 5.2
- ROLE_USER_ADMIN: Added in Cloudera Manager 5.2
- ROLE_KEY_ADMIN: Added in Cloudera Manager 5.5

An empty list implies ROLE_USER.

Note that although this interface provides a list of roles, a user should only be assigned a single role at a time.

pwHash | string | NOTE: Only available in the "export" view
pwSalt | number | NOTE: Only available in the "export" view
pwLogin | boolean | NOTE: Only available in the "export" view

Example

    {
      "name" : "...",
      "password" : "...",
      "roles" : [ "...", "..." ],
      "pwHash" : "...",
      "pwSalt" : 12345,
      "pwLogin" : true
    }