Roles

Get role

Get role details by ID.

get/api/roles/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/roles/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the role.

Response

Details of the role.

tenantIdstring required
idstring required
namestring required
descriptionstring required
type'User' | 'MachineToMachine' required
isDefaultboolean required

Changes

No recorded changes to this operation across all 8 revisions of this API.