Update user role

PUT/v2/users/{id}/role

Changes the role of a member of the organization and returns the updated user. You can't change your own role. Only owners using a personal access token (PAT) can assign owner or change an owner's role.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`

Body

Object representing a user's role update request

application/json

Property	Type	Description
`role`	`string`Required	Role identifier to assign to the user

Request

curl -X PUT 'https://api.axiom.co/v2/users/ID/role' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"role":"admin"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredid pathRequiredRequest body application/json

Response

200Updated user.

application/json

403Insufficient permissions, you tried to change your own role, or the caller isn't allowed to assign or change the `owner` role.

404User or role not found.

Property	Type	Description
`email`	`string`Required	User's email address
`id`	`string`Required	Unique identifier for the user
`name`	`string`Required	User's full name
`role`	`object`Required	Detailed information about a user's role
`id`	`string`Required	Unique identifier for the role
`name`	`string`Required	Human-readable name of the role