Get full sign-in experience

GET /api/.well-known/experience

Get the full sign-in experience configuration.

Responses

  • 200 application/json

    The full sign-in experience configuration.

    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.

    • color object Required

      Additional properties are allowed.

      Hide color attributes Show color attributes object
      • primaryColor string(regex) Required

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

      • isDarkModeEnabled boolean Required
      • darkPrimaryColor string(regex) Required

        Format should match the following pattern: /^#[\da-f]{3}([\da-f]{3})?$/i.

    • branding object Required

      Additional properties are allowed.

      Hide branding attributes Show branding attributes object
    • languageInfo object Required

      Additional properties are allowed.

      Hide languageInfo attributes Show languageInfo attributes object
      • autoDetect boolean Required
      • fallbackLanguage string Required

        Values are af-ZA, am-ET, ar, ar-AR, as-IN, az-AZ, be-BY, bg-BG, bn-IN, br-FR, bs-BA, ca-ES, cb-IQ, co-FR, cs-CZ, cx-PH, cy-GB, da-DK, de, de-DE, el-GR, en, en-GB, en-US, eo-EO, es, es-ES, es-419, et-EE, eu-ES, fa-IR, ff-NG, fi-FI, fo-FO, fr, fr-CA, fr-FR, fy-NL, ga-IE, gl-ES, gn-PY, gu-IN, ha-NG, he-IL, hi-IN, hr-HR, ht-HT, hu-HU, hy-AM, id-ID, ik-US, is-IS, it, it-IT, iu-CA, ja, ja-JP, ja-KS, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko, ko-KR, ku-TR, ky-KG, lo-LA, lt-LT, lv-LV, mg-MG, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, mt-MT, my-MM, nb-NO, ne-NP, nl-BE, nl-NL, nn-NO, or-IN, pa-IN, pl-PL, ps-AF, pt, pt-BR, pt-PT, ro-RO, ru, ru-RU, rw-RW, sc-IT, si-LK, sk-SK, sl-SI, sn-ZW, sq-AL, sr-RS, sv-SE, sw-KE, sy-SY, sz-PL, ta-IN, te-IN, tg-TJ, th-TH, tl-PH, tr, tr-TR, tt-RU, tz-MA, uk-UA, ur-PK, uz-UZ, vi-VN, zh, zh-CN, zh-HK, zh-MO, zh-TW, or zz-TR.

    • termsOfUseUrl string | null Required

      Maximum length is 2048.

    • privacyPolicyUrl string | null Required

      Maximum length is 2048.

    • agreeToTermsPolicy string Required

      Values are Automatic, ManualRegistrationOnly, or Manual.

    • signIn object Required

      Additional properties are allowed.

      Hide signIn attribute Show signIn attribute object
    • signUp object Required

      Additional properties are allowed.

      Hide signUp attributes Show signUp attributes object
    • socialSignIn object Required

      Additional properties are allowed.

      Hide socialSignIn attribute Show socialSignIn attribute object
    • socialSignInConnectorTargets array[string] Required
    • signInMode string Required

      Values are SignIn, Register, or SignInAndRegister.

    • customCss string | null Required
    • customContent object Required
      Hide customContent attribute Show customContent attribute object
      • * string Additional properties
    • customUiAssets object | null Required

      Additional properties are allowed.

      Hide customUiAssets attributes Show customUiAssets attributes object | null
    • passwordPolicy object Required

      Additional properties are allowed.

      Hide passwordPolicy attributes Show passwordPolicy attributes object
      • length object

        Default value is {} (empty). Additional properties are allowed.

        Hide length attributes Show length attributes object
        • min number Required

          Default value is 8.

        • max number Required

          Default value is 256.

      • Default value is {} (empty). Additional properties are allowed.

        Hide characterTypes attribute Show characterTypes attribute object
        • min number Required

          Default value is 1.

      • rejects object

        Default value is {} (empty). Additional properties are allowed.

        Hide rejects attributes Show rejects attributes object
    • mfa object Required

      Additional properties are allowed.

      Hide mfa attributes Show mfa attributes object
      • factors array[string] Required

        Values are Totp, WebAuthn, or BackupCode.

      • policy string Required

        Values are UserControlled or Mandatory.

    • singleSignOnEnabled boolean Required
    • supportEmail string | null Required
    • supportWebsiteUrl string | null Required
    • unknownSessionRedirectUrl string | null Required
    • socialConnectors array[object] Required
      Hide socialConnectors attributes Show socialConnectors attributes object
    • ssoConnectors array[object] Required
      Hide ssoConnectors attributes Show ssoConnectors attributes object
    • forgotPassword object Required

      Additional properties are allowed.

      Hide forgotPassword attributes Show forgotPassword attributes object
    • isDevelopmentTenant boolean Required
    • Additional properties are allowed.

      Hide googleOneTap attributes Show googleOneTap attributes object
  • Bad Request

GET /api/.well-known/experience
curl \
 -X GET https://[tenant_id].logto.app/api/.well-known/experience
Response examples (200)
{
  "tenantId": "string",
  "id": "string",
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "languageInfo": {
    "autoDetect": true,
    "fallbackLanguage": "af-ZA"
  },
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string",
  "agreeToTermsPolicy": "Automatic",
  "signIn": {
    "methods": [
      {
        "identifier": "username",
        "password": true,
        "verificationCode": true,
        "isPasswordPrimary": true
      }
    ]
  },
  "signUp": {
    "identifiers": [
      "username"
    ],
    "password": true,
    "verify": true
  },
  "socialSignIn": {
    "automaticAccountLinking": true
  },
  "socialSignInConnectorTargets": [
    "string"
  ],
  "signInMode": "SignIn",
  "customCss": "string",
  "customContent": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "customUiAssets": {
    "id": "string",
    "createdAt": 42.0
  },
  "passwordPolicy": {
    "length": {
      "min": 8,
      "max": 256
    },
    "characterTypes": {
      "min": 1
    },
    "rejects": {
      "pwned": true,
      "repetitionAndSequence": true,
      "userInfo": true,
      "words": []
    }
  },
  "mfa": {
    "factors": [
      "Totp"
    ],
    "policy": "UserControlled"
  },
  "singleSignOnEnabled": true,
  "supportEmail": "string",
  "supportWebsiteUrl": "string",
  "unknownSessionRedirectUrl": "string",
  "socialConnectors": [
    {
      "id": "string",
      "target": "string",
      "name": {},
      "logo": "string",
      "logoDark": "string",
      "fromEmail": "string",
      "platform": "Native",
      "isStandard": true
    }
  ],
  "ssoConnectors": [
    {
      "id": "string",
      "connectorName": "string",
      "logo": "string",
      "darkLogo": "string"
    }
  ],
  "forgotPassword": {
    "phone": true,
    "email": true
  },
  "isDevelopmentTenant": true,
  "googleOneTap": {
    "isEnabled": true,
    "autoSelect": true,
    "closeOnTapOutside": true,
    "itpSupport": true,
    "clientId": "string",
    "connectorId": "string"
  }
}