Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/directus/directus/llms.txt

Use this file to discover all available pages before exploring further.

Roles define groups of users with shared permissions.

List Roles

GET /roles
Example:
curl "https://your-directus-instance.com/roles" \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Role

GET /roles/:id

Create Role

POST /roles
Request Body:
{
  "name": "Editor",
  "icon": "supervised_user_circle",
  "description": "Can edit content",
  "admin_access": false,
  "app_access": true
}

Update Role

PATCH /roles/:id

Delete Role

DELETE /roles/:id

Role Properties

id
string
Role UUID
name
string
Role name
icon
string
Material icon name
admin_access
boolean
Full admin access
app_access
boolean
Can access the admin app

Next Steps

Users

Manage users

Permissions

Configure permissions