Get application API resource roles

GET /api/applications/{applicationId}/roles

OAuth2

Get API resource roles assigned to the specified application with pagination.

Path parameters

applicationId string Required

The unique identifier of the application.

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 roles assigned to the application.
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.
- name string Required
  
  Minimum length is 1, maximum length is 128.
- description string Required
  
  Minimum length is 1, maximum length is 128.
- type string Required
  
  Values are User or MachineToMachine.
- isDefault boolean Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

Not Found
422

Unprocessable Content

GET /api/applications/{applicationId}/roles

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

Response examples (200)

[
  {
    "tenantId": "string",
    "id": "string",
    "name": "string",
    "description": "string",
    "type": "User",
    "isDefault": true
  }
]