Updates an existing user in the system.
To invoke this endpoint in the Console UI:
- Navigate to Manage > Authentication > Users.
- In a table row, click the Actions button for the user to update.
- Click the Manage button and update the user's parameters.
- Click the Save button to save the updated user.
The following example command changes the role of a user to
In general, you should get the user object from
GET /api/v<VERSION>/users and resubmit all key-value pairs, changing just the values that need updating.
If key-values are left unspecified, their default values will override any current values (note the exception below).
For example, if
permissions.collections specified a collection named
finance-app, but the submitted request omitted
permissions.collections, its value would be reset to
For "local" users, where
authType is set to
basic: if a password isn't specified, it's left as-is.
For any other
authType, passwords are managed by the identity provider (IdP), and aren't specified in the request body.
$ curl 'https://<CONSOLE>/api/v<VERSION>/users' \
-X PUT \
-u <USER> \
-H 'Content-Type: application/json' \
Note: No response will be returned upon successful execution.
- Array [
Possible values: [
AuthType is the user authentication type
Datetime when the user was created or last modified.
Password for authentication.
Permissions is a list of permissions
List of collections the user can access.
Names of projects which the user can access.
Username for authentication.