Documentation

Roles

Create a new role

Creates a new custom role with optional permissions.

ProductionStagingUAT
POSThttps://ankiren.com/api/admin/roles

Request Body

Bắt buộc.

  • namestringRequired
  • descriptionstring
  • permissions[string]
application/json
{
  "name": "moderator",
  "description": "Content moderator",
  "permissions": [
    "perm_users_manage"
  ]
}

Responses

201 · Role created successfully

  • idstring
  • namestring
  • descriptionstring
  • isSystemboolean
  • createdAtstring<date-time>
    format: date-time
  • updatedAtstring<date-time>
    format: date-time
application/json
{
  "id": "role_admin",
  "name": "admin",
  "description": "System administrator with full access",
  "isSystem": true,
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z"
}

Sample Code

Đổi ngôn ngữ ở ô Language trên thanh Documentation.

cURL
curl -X POST 'https://ankiren.com/api/admin/roles' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "moderator",
  "description": "Content moderator",
  "permissions": [
    "perm_users_manage"
  ]
}'