Change a member's role

patch

https://api.qfp.quantnetwork.net/api/tenants/{id}/users/{userId}/role

Moves one member of the caller's own tenant onto another role.

Requires role:assign, and the role being assigned is gated exactly
as creating a user with it is: a platform role needs the matching
*:create permission, and a custom role may not grant a permission
the caller does not hold.

Checks, in order:

The path tenant equals the caller's tenant_id claim (403).
The caller resolves and is ACTIVE (401).
The caller holds role:assign (403).
The target is not the caller (400).
The target exists within that tenant (404).
The target is not the tenant's owner (400).
The target is ACTIVE or INVITED (400).

A blank or absent roleName means USER. A member already on the
requested role is returned unchanged.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The member on their new role.

400roleName is blank or longer than 50 characters, the caller is changing their own role, the target is the tenant owner, or the target has no platform access.

401No usable token, or the caller's own status is not ACTIVE (Your access has been revoked.).

404No user with this id in this tenant (User not found), or roleName names neither a platform role nor a custom role of this tenant (Role {name} not found).