Update a user

put

https://api.linode.com/{apiVersion}/account/users/{username}

Update information about a user on your account, including its restricted status. When setting a user to restricted, the API sets no grants for it. You need to set grants so that user can access things on the account.

🚧
RBAC Identity and Access
If Identity and Access is enabled on your account, the restricted users have the account_admin role and restricted users have specific roles assigned to them. To update the role assignment, run the Update a user's access level operation instead. To learn more, see Identity and Access for Akamai Cloud.

Parent and child accounts

In the context of the parent and child accounts feature, on a child account, you can't edit the username or email values for delegate users.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

Identity and access permissions. Your user needs a role with these permissions. Learn more.
- Permissions: update_user
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: account:read_write

CLI

linode-cli users update example_user \
  --username example_user \
  --email example@linode.com \
  --restricted true

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

username

string

required

The username to look up.

Body Params

A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to.

string

This user's email address. Akamai uses this address for account management communications.

restricted

boolean

Defines user access to account. If false, the user is assigned the account_admin role. If true, the user's access is limited to selected roles.

username

string

length between 3 and 32

^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$

Filterable The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.

Responses

200User updated successfully.

defaultSee Errors for the range of possible error response codes.