/{app_slug}/v1/admin/roles/{role_name}AuthUpdate a role's description
Renames are intentionally NOT supported — the role name is part of every issued EndUser JWT, so changing it would silently break live sessions. Create a new role and migrate users instead.
Path parameters
app_slug*stringSlug of the app.
role_name*stringName of the role (e.g. `admin`).
Request body
descriptionstringFree-text description of the update role, or `null`.
Example: "Updated description"
Response · 200
id*stringUnique identifier of the role.
app_id*stringThe Auth app the role belongs to.
name*stringName of the role.
description*stringFree-text description of the role, or `null`.
is_system*booleanTrue for the built-in roles every app has; they cannot be renamed or deleted.
created_at*string · date-timeWhen the role was created (ISO 8601).
updated_at*string · date-timeWhen the role was last changed (ISO 8601).
Example
Request
PATCH https://api.auth.productcraft.co/{app_slug}/v1/admin/roles/{role_name}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json
{
"description": "Updated description"
}Response
{
"id": "string",
"app_id": "string",
"name": "string",
"description": "string",
"is_system": false,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}