Parameter | Description |
---|---|
The email of the user. | |
Enabled | Specifies whether the user is enabled. The default value is true. |
Full Name | The full name of the user. |
Metadata | Arbitrary metadata that you want to associate with the user. |
Password | The user’s password. Passwords must be at least 6 characters long. When adding a user, one of password or password_hash is required. |
Password Hash | A hash of the user’s password. This must be produced using the same hashing algorithm as has been configured for password storage. Using this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons. The password parameter and the password_hash parameter cannot be used in the same request. |
Roles | A set of roles the user has. The roles determine the user’s access permissions. To create a user without any roles, specify an empty list -> []. |
Username | An identifier for the user. Usernames must be at least 1 and no more than 1024 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block. Leading or trailing whitespace is not allowed. |