Role-Based Access Control
Operations for managing Role-Based Access Control (RBAC) roles, enabling the assignment of pre-configured sets of permissions and policies to users within your organization.
| Endpoint Name | URL | Description |
|---|---|---|
| List RBAC roles | GET /auth/roles | Returns a list of existing RBAC roles. |
| Create RBAC role | POST /auth/roles | Creates an RBAC role. |
| Retrieve RBAC role details | GET /auth/roles/{id} | Retrieves the details of an existing RBAC role. |
| Update RBAC role | PUT /auth/roles/{id} | Modifies an RBAC role. |
| Delete RBAC role | DELETE /auth/roles/{id} | Deletes an RBAC role. |
| Assign RBAC role to organization member | PUT /auth/users/{user_id}/assign-roles | Assigns an RBAC role to a member of your organization, granting them the specified permissions and policies. |
| Revoke RBAC role from organization member | DELETE /auth/users/{user_id}/roles | Removes an RBAC role from a member of your organization, revoking the specified permissions and policies. |
The RBAC roles object
RBAC endpoints return the roles object, offering details about your RBAC roles. This includes the name, environment, public key, creation timestamp, fingerprint, and ID.
Attributes
id integer
The unique identifier for the RBAC role.
name string
The name of the RBAC role.
description string
A description of the RBAC role.
policies array
An array containing information about policies assigned to the RBAC role.
Show child attributes
permissions array
An array containing information about permissions assigned to the RBAC role.
Show child attributes
created_at date-time
The timestamp when the RBAC role was created.
Response
{
"id": 64,
"name": "example-role",
"description": "This is an test RBAC role.",
"policies": [
{
"description": "Gives read-only access to all resources",
"id": 2,
"name": "policy:ReadPermissions"
}
],
"permissions": [
{
"resource": "Environment",
"permission": "environment:create",
"id": 2
}
],
"created_at": "2024-02-08T09:45:34",
}