Modify user account

Edit online

Modifies the email address or role of the user account. The parameters are all optional and can be issued separately. Only an administrator can modify a user account’s role or email. Names of user accounts cannot be modified in this way.

Request syntax

PATCH /v1/authentication/userAccounts/{name} {"role": <role>, "email": <email>}
Modifies the email address or role of the user account.

Path parameters

name (string, required): The unique name of the user account.

Request body parameters

role (string, optional): The name of the new role that defines which commands the user account is allowed to execute.

email (string, optional): The new email address for the user account. This should not be included for Diamondback as email is not supported.

Example

> PATCH /v1/authentication/userAccounts/manager1 {"role": "Administrator"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

Returns 400 Bad Command if role is not an existing role name.
Returns 400 Bad Command if email is not a valid email account.