Path parameters
-
id
string Required The unique identifier of the role.
Body
Required
-
name
string The name of the role. It should be unique within the tenant.
Minimum length is
1
, maximum length is128
. -
description
string Minimum length is
1
, maximum length is128
. -
isDefault
boolean
PATCH
/api/roles/{id}
curl \
--request PATCH 'https://[tenant_id].logto.app/api/roles/{id}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"name":"string","description":"string","isDefault":true}'
Request examples
{
"name": "string",
"description": "string",
"isDefault": true
}
Response examples (200)
{
"tenantId": "string",
"id": "string",
"name": "string",
"description": "string",
"type": "User",
"isDefault": true
}