Logto API references

Get role applications

GET /api/roles/{id}/applications

Get applications that have the role assigned with pagination.

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.

Responses

• 200 application/json

An array of applications that have the role assigned.
Hide response attributes Show response attributes object
- id string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Minimum length is 1, maximum length is 256.
- secret string Required
  
  Minimum length is 1, maximum length is 64.
- description string | null Required
- type string Required
  
  Values are Native, SPA, Traditional, MachineToMachine, or Protected.
- oidcClientMetadata object Required
  
  Hide oidcClientMetadata attributes Show oidcClientMetadata attributes
  
  redirectUris array[object] Required
  
  One of:
  object-1 object object-2 object
  
  Validator function
  
  Validator function
  
  postLogoutRedirectUris array[string(url)] Required
  
  logoUri string
- customClientMetadata object Required
  
  Hide customClientMetadata attributes Show customClientMetadata attributes
  
  corsAllowedOrigins array[string]
  
  Minimum length of each is 1.
  
  idTokenTtl number
  
  refreshTokenTtl number
  
  refreshTokenTtlInDays number
  
  alwaysIssueRefreshToken boolean
  
  rotateRefreshToken boolean
- protectedAppMetadata object | null Required
  
  Hide protectedAppMetadata attributes Show protectedAppMetadata attributes
  
  host string Required
  
  origin string Required
  
  sessionDuration number Required
  
  pageRules array[object] Required
  
  Hide pageRules attribute Show pageRules attribute object
  
  path string Required
  
  customDomains array[object]
  
  Hide customDomains attributes Show customDomains attributes object
  
  domain string Required
  
  status string Required
  
  Values are PendingVerification, PendingSsl, Active, or Error.
  
  errorMessage string | null Required
  
  dnsRecords array[object] Required
  
  Hide dnsRecords attributes Show dnsRecords attributes object
  
  name string Required
  
  type string Required
  
  value string Required
  
  cloudflareData object | null Required
  
  Hide cloudflareData attributes Show cloudflareData attributes
  
  id string Required
  
  status string Required
  
  ssl object Required
  
  Hide ssl attributes Show ssl attributes
  
  status string Required
  
  validation_errors array[object]
  
  Hide validation_errors attribute Show validation_errors attribute object
  
  message string Required
  
  verification_errors array[string]
- isThirdParty boolean Required
- createdAt number Required
• 204

No Content
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/roles/{id}/applications

curl \
 -X GET https://[tenant_id].logto.app/api/roles/{id}/applications

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "secret": "string",
    "description": "string",
    "type": "Native",
    "oidcClientMetadata": {
      "redirectUris": [
        {}
      ],
      "postLogoutRedirectUris": [
        "string"
      ],
      "logoUri": "string"
    },
    "customClientMetadata": {
      "corsAllowedOrigins": [
        "string"
      ],
      "idTokenTtl": 42.0,
      "refreshTokenTtl": 42.0,
      "refreshTokenTtlInDays": 42.0,
      "alwaysIssueRefreshToken": true,
      "rotateRefreshToken": true
    },
    "protectedAppMetadata": {
      "host": "string",
      "origin": "string",
      "sessionDuration": 42.0,
      "pageRules": [
        {
          "path": "string"
        }
      ],
      "customDomains": [
        {
          "domain": "string",
          "status": "PendingVerification",
          "errorMessage": "string",
          "dnsRecords": [
            {
              "name": "string",
              "type": "string",
              "value": "string"
            }
          ],
          "cloudflareData": {
            "id": "string",
            "status": "string",
            "ssl": {
              "status": "string",
              "validation_errors": [
                {
                  "message": "string"
                }
              ]
            },
            "verification_errors": [
              "string"
            ]
          }
        }
      ]
    },
    "isThirdParty": true,
    "createdAt": 42.0
  }
]