Get role scopes

GET /api/roles/{id}/scopes

OAuth2

Get API resource scopes (permissions) linked with a role.

Path parameters

id string Required

The unique identifier of the role.

Query parameters

page integer

Page number (starts from 1).

Minimum value is 1. Default value is 1.
page_size integer

Entries per page.

Minimum value is 1. Default value is 20.
search_params object

Search query parameters.
Hide search_params attributes Show search_params attributes
- Additional properties
- key string

Responses

200 application/json

An array of API resource scopes linked with the role.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- resourceId string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Minimum length is 1, maximum length is 256.
- description string | null Required
- createdAt number Required
- resource object Required
  
  Hide resource attributes Show resource attributes
  
  tenantId string Required
  
  Maximum length is 21.
  
  id string Required
  
  Minimum length is 1, maximum length is 21.
  
  name string Required
  
  Minimum length is 1.
  
  indicator string Required
  
  Minimum length is 1.
  
  isDefault boolean Required
  
  accessTokenTtl number Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/roles/{id}/scopes

curl \
 -X GET https://[tenant_id].logto.app/api/roles/{id}/scopes \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "tenantId": "string",
    "id": "string",
    "resourceId": "string",
    "name": "string",
    "description": "string",
    "createdAt": 42.0,
    "resource": {
      "tenantId": "string",
      "id": "string",
      "name": "string",
      "indicator": "string",
      "isDefault": true,
      "accessTokenTtl": 42.0
    }
  }
]