Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Role

Create a role

Create a new role.

Permissions

This endpoint requires the following permissions:

  • Role:CreateRole for the role.
post/v1/{organization}/role/

Path parameters

organizationstring required

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

role_namestring required
descriptionstring required
frontend_view'client' | 'admin' required

Response

Succeeded

role_idstring required

The ID of the newly created role.