Update organization role
Update organization role details by ID with the given data.
Path parameters
-
id
string Required The unique identifier of the organization role.
Body
Required
-
tenantId
string Maximum length is
21
. -
id
string Minimum length is
1
, maximum length is21
. -
name
string The updated name of the organization role. It must be unique within the organization template.
Minimum length is
1
, maximum length is128
. -
description
string | null The updated description of the organization role.
Maximum length is
256
. -
type
string Values are
User
orMachineToMachine
.
PATCH
/api/organization-roles/{id}
curl \
--request PATCH 'https://[tenant_id].logto.app/api/organization-roles/{id}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"tenantId":"string","id":"string","name":"string","description":"string","type":"User"}'
Request examples
{
"tenantId": "string",
"id": "string",
"name": "string",
"description": "string",
"type": "User"
}
Response examples (200)
{
"tenantId": "string",
"id": "string",
"name": "string",
"description": "string",
"type": "User"
}