Role
Get roles
Return a list of roles in this organization.
Permissions
This endpoint may be impacted by the following permissions:
- Only roles that the authenticated user has the Role:GetRole permission on will be returned.
get/v1/{organization}/role/
Request
- Base URLhttps://api.amigo.ai
- AuthHTTP bearer and API key in header X-ORG-ID and HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
organizationstring required
Query parameters
return_permission_grantsboolean
Whether to return permission grants.
idstring[]
The IDs of the roles to retrieve.
namestring[]
The names of the roles to retrieve.
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.
Sec-WebSocket-Protocolstring[]
Response
Succeeded
Changes
No operation changes recorded.