Update role

Updates role description and/or permissions. System role names cannot be modified.

ProductionStagingUAT

PUThttps://ankiren.com/api/admin/roles/{id}

Parameters

Path Parameters

idstringpathRequired
Role ID

Request Body

Bắt buộc.

descriptionstring
permissions[string]

application/json

{
  "description": "Updated description",
  "permissions": [
    "perm_users_manage",
    "perm_roles_assign"
  ]
}

Responses

200 · Role updated 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 PUT 'https://ankiren.com/api/admin/roles/role_admin' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Updated description",
  "permissions": [
    "perm_users_manage",
    "perm_roles_assign"
  ]
}'