Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Role

Assign a role to user

Assign a role to a user.

Permissions

This endpoint requires the following permissions:

  • The authenticated user to have greater privileges than the role being assigned.
post/v1/{organization}/role/{role_name}/assign

Path parameters

organizationstring required
role_namestring required

The name of the role to assign.

The name of the role to assign.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

user_idstring required

The identifier of the user to assign the role to.

Response

Succeeded

role_idstring required

The identifier of the role assigned to the user.