V1/role
Was this helpful?
Was this helpful?
Return a list of roles in this organization.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo
for the authenticated user.
This endpoint may be impacted by the following permissions:
Only roles that the authenticated user has the Role:GetRole
permission on will be returned.
Whether to return permission grants.
false
The ID of the role to get.
[]
The name of the role to get.
[]
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.
Create a new role.
Permissions
This endpoint requires the following permissions:
User:GetUserInfo
for the authenticated user.
Role:CreateRole
for the role.
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 name of the role to create. The role must have a max length of 256 characters.
A description about the role.
The frontend view for users of this role.
Whether this role is a base role. Base roles cannot inherit from other roles. One can only inherit from base roles.
The ID of the role that this role inherits from.
^[a-f0-9]{24}$
Modify an existing role. The roles are modified in-place unless immutable fields are modified, in which case a new role with the same name is created, and all users/API keys assigned to the previous role are switched to the new role. The old role document will expire after 1 day.
If a base role is updated, all of its dependent roles will also be updated (by creating a new version of it), and all users/API keys assigned to the role will be switched to the new role.
Permissions
This endpoint requires the following permissions:
Role:ModifyRole
for the role and, if it's a base role, all of its dependent roles.
This endpoint may require the authenticated user to have great privileges than the new role if a new role document is created as a result of immutable field changes.
The name of the role.
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.
A description about the role. Only updated if specified. This field is a mutable field.
A list of permission grants associated with this role. Only updated if specified. This field is an immutable field.
The frontend view for the user of this role. Only updated if specified. This field is an immutable field.
The ID of the role that this role inherits from. Only updated if specified. This field is an immutable field.
{}
^[a-f0-9]{24}$
A specific type to indicate that a field is not set in the request.
Assign a role to a user.
Permissions
This endpoint requires the following permissions:
User.GetUserInfo
for the authenticated user.
The authenticated user to have greater privileges than the role being assigned.
The name of the role to assign.
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 identifier of the user to assign the role to.