Documentation

Roles

Get role details

Returns role with permissions and assigned users.

ProductionStagingUAT
GEThttps://ankiren.com/api/admin/roles/{id}

Parameters

Path Parameters

  • idstringpathRequired

    Role ID

Responses

200 · Role details

  • idstring
  • namestring
  • descriptionstring
  • isSystemboolean
  • createdAtstring<date-time>
    format: date-time
  • updatedAtstring<date-time>
    format: date-time
  • permissions[PermissionSummary]
    • idstring
    • namestring
    • descriptionstring
  • users[UserSummary]
    • idstring
    • emailstring<email>
      format: email
    • namestring
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",
  "permissions": [
    {
      "id": "perm_users_manage",
      "name": "users:manage",
      "description": "Create, edit, delete users"
    }
  ],
  "users": [
    {
      "id": "user_123",
      "email": "[email protected]",
      "name": "Admin User"
    }
  ]
}

Sample Code

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

cURL
curl -X GET 'https://ankiren.com/api/admin/roles/role_admin' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'