Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Logto Experience API

Topics

  • Introduction
  • Authentication

Endpoints

  • Experience
    • Init new interaction PUT
    • Update interaction event PUT
    • Identify user for the current interaction POST
    • Submit interaction POST
    • Create password verification record POST
    • Create and send verification code POST
    • Verify verification code POST
    • Create social verification POST
    • Verify social verification POST
    • Create enterprise SSO verification POST
    • Verify enterprise SSO verification POST
    • Create TOTP secret POST
    • Verify TOTP verification POST
    • Create WebAuthn registration verification POST
    • Verify WebAuthn registration verification POST
    • Create WebAuthn authentication verification POST
    • Verify WebAuthn authentication verification POST
    • Generate backup codes POST
    • Verify backup code POST
    • Create new password identity verification POST
    • Update user profile data POST
    • Reset user password PUT
    • Skip MFA binding flow POST
    • Bind MFA verification by verificationId POST
    • Get enabled SSO connectors by the given email's domain GET
  • Interaction
    • PUT /api/interaction PUT
    • DELETE /api/interaction DELETE
    • PUT /api/interaction/event PUT
    • PATCH /api/interaction/identifiers PATCH
    • PUT /api/interaction/profile PUT
    • DELETE /api/interaction/profile DELETE
    • PATCH /api/interaction/profile PATCH
    • POST /api/interaction/submit POST
    • GET /api/interaction/consent GET
    • POST /api/interaction/consent POST
    • POST /api/interaction/verification/social-authorization-uri POST
    • POST /api/interaction/verification/verification-code POST
    • POST /api/interaction/verification/totp POST
    • POST /api/interaction/verification/webauthn-registration POST
    • POST /api/interaction/verification/webauthn-authentication POST
    • POST /api/interaction/bind-mfa POST
    • PUT /api/interaction/mfa PUT
    • PUT /api/interaction/mfa-skipped PUT
    • POST /api/interaction/single-sign-on/{connectorId}/authorization-url POST
    • POST /api/interaction/single-sign-on/{connectorId}/authentication POST
    • POST /api/interaction/single-sign-on/{connectorId}/registration POST
    • GET /api/interaction/single-sign-on/connectors GET
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Logto Experience API

GET /api/interaction/consent

View as markdown
GET /api/interaction/consent

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • application object Required
      Hide application attributes Show application attributes object
      • id string Required

        Minimum length is 1, maximum length is 21.

      • name string Required

        Minimum length is 1, maximum length is 256.

      • branding object
        Hide branding attributes Show branding attributes object
        • logoUrl string(url)
        • darkLogoUrl string(url)
        • favicon string(url)
        • darkFavicon string(url)
      • displayName string | null

        Maximum length is 256.

      • privacyPolicyUrl string | null

        Maximum length is 2048.

      • termsOfUseUrl string | null

        Maximum length is 2048.

    • user object Required
      Hide user attributes Show user attributes object
      • id string Required

        Minimum length is 1, maximum length is 12.

      • name string | null Required

        Maximum length is 128.

      • avatar string | null Required

        Maximum length is 2048.

      • username string | null Required

        Maximum length is 128.

      • primaryEmail string | null Required

        Maximum length is 128.

      • primaryPhone string | null Required

        Maximum length is 128.

    • organizations array[object]
      Hide organizations attributes Show organizations attributes object
      • id string Required

        Minimum length is 1, maximum length is 21.

      • name string Required

        Minimum length is 1, maximum length is 128.

      • missingResourceScopes array[object]
        Hide missingResourceScopes attributes Show missingResourceScopes attributes object
        • resource object Required
          Hide resource attributes Show resource attributes object
          • name string Required

            Minimum length is 1.

          • indicator string Required

            Minimum length is 1.

          • id string Required
        • 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
    • missingOIDCScope array[string]
    • missingResourceScopes array[object]
      Hide missingResourceScopes attributes Show missingResourceScopes attributes object
      • resource object Required
        Hide resource attributes Show resource attributes object
        • name string Required

          Minimum length is 1.

        • indicator string Required

          Minimum length is 1.

        • id string Required
      • 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
    • redirectUri string Required
GET /api/interaction/consent
curl \
 --request GET 'https://[tenant_id].logto.app/api/interaction/consent'
Response examples (200)
{
  "application": {
    "id": "string",
    "name": "string",
    "branding": {
      "logoUrl": "string",
      "darkLogoUrl": "string",
      "favicon": "string",
      "darkFavicon": "string"
    },
    "displayName": "string",
    "privacyPolicyUrl": "string",
    "termsOfUseUrl": "string"
  },
  "user": {
    "id": "string",
    "name": "string",
    "avatar": "string",
    "username": "string",
    "primaryEmail": "string",
    "primaryPhone": "string"
  },
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "missingResourceScopes": [
        {
          "resource": {
            "name": "string",
            "indicator": "string",
            "id": "string"
          },
          "scopes": [
            {
              "id": "string",
              "name": "string",
              "description": "string"
            }
          ]
        }
      ]
    }
  ],
  "missingOIDCScope": [
    "string"
  ],
  "missingResourceScopes": [
    {
      "resource": {
        "name": "string",
        "indicator": "string",
        "id": "string"
      },
      "scopes": [
        {
          "id": "string",
          "name": "string",
          "description": "string"
        }
      ]
    }
  ],
  "redirectUri": "string"
}