Get API resource scopes

GET /api/resources/{resourceId}/scopes

O auth2

Get scopes (permissions) defined for an API resource.

Path parameters

resourceId string Required

The unique identifier of the resource.

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 attribute Show search_params attribute object
- * string Additional properties

Responses

200 application/json

An array of scopes for the requested resource.
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
400

Bad Request
401

Unauthorized
403

Forbidden

GET /api/resources/{resourceId}/scopes

curl \
 --request GET 'https://[tenant_id].logto.app/api/resources/{resourceId}/scopes' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "tenantId": "string",
    "id": "string",
    "resourceId": "string",
    "name": "string",
    "description": "string",
    "createdAt": 42.0
  }
]