List all the user consent scopes of an application.

GET /api/applications/{applicationId}/user-consent-scopes
OAuth2

List all the user consent scopes of an application by application id

Path parameters

Responses

  • 200 application/json

    All the user consent scopes of the application are listed successfully

    Hide response attributes Show response attributes object
    • organizationScopes array[object] Required

      A list of organization scope details assigned to the application.

      Hide organizationScopes attributes Show organizationScopes attributes object
      • id string Required

        Minimum length is 1, maximum length is 21.

      • name string Required

        Minimum length is 1, maximum length is 128.

      • description string | null Required

        Maximum length is 256.

    • resourceScopes array[object] Required

      A list of resource scope details grouped by resource id assigned to the application.

      Hide resourceScopes attributes Show resourceScopes attributes object
      • resource object Required

        Additional properties are allowed.

        Hide resource attributes Show resource attributes object
        • 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.

      • scopes array[object] Required
        Hide scopes attributes Show scopes attributes object
        • id 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
    • organizationResourceScopes array[object] Required

      A list of organization resource scope details grouped by resource id assigned to the application.

      Hide organizationResourceScopes attributes Show organizationResourceScopes attributes object
      • resource object Required

        Additional properties are allowed.

        Hide resource attributes Show resource attributes object
        • 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.

      • scopes array[object] Required
        Hide scopes attributes Show scopes attributes object
        • id 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
    • userScopes array[string] Required

      A list of user scope enum value assigned to the application.

      Values are profile, email, phone, address, custom_data, identities, roles, urn:logto:scope:organizations, or urn:logto:scope:organization_roles.
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    The application is not found

GET /api/applications/{applicationId}/user-consent-scopes 
curl \
 -X GET https://[tenant_id].logto.app/api/applications/{applicationId}/user-consent-scopes \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "organizationScopes": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "resourceScopes": [
    {
      "resource": {
        "id": "string",
        "name": "string",
        "indicator": "string"
      },
      "scopes": [
        {
          "id": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }
  ],
  "organizationResourceScopes": [
    {
      "resource": {
        "id": "string",
        "name": "string",
        "indicator": "string"
      },
      "scopes": [
        {
          "id": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }
  ],
  "userScopes": [
    "profile"
  ]
}