Responses

• • 200 application/json

  The full sign-in experience configuration.

  Hide response attributes Show response attributes object

  • id string Required

    Minimum length is 1, maximum length is 21.

  • color object Required
    Hide color attributes Show color attributes

    • 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
    Hide branding attributes Show branding attributes

    • logoUrl string(url)
    • darkLogoUrl string(url)
    • favicon string(url)
  • languageInfo object Required
    Hide languageInfo attributes Show languageInfo attributes

    • autoDetect boolean Required
    • fallbackLanguage string Required

      Values are af-ZA, am-ET, 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.

  • signIn object Required
    Hide signIn attribute Show signIn attribute

    • methods array[object] Required
      Hide methods attributes Show methods attributes object

      • identifier string Required

        Values are username, email, or phone.

      • password boolean Required
      • verificationCode boolean Required
      • isPasswordPrimary boolean Required
  • signUp object Required
    Hide signUp attributes Show signUp attributes

    • identifiers array[string] Required

      Values are username, email, or phone.

    • password boolean Required
    • verify boolean Required
  • socialSignInConnectorTargets array[string] Required
  • signInMode string Required

    Values are SignIn, Register, or SignInAndRegister.

  • customCss string | null Required
  • customContent object Required
    Hide customContent attributes Show customContent attributes

    • Additional properties
    • key string
  • passwordPolicy object Required
    Hide passwordPolicy attributes Show passwordPolicy attributes

    • length object

      Default value is {} (empty).

      Hide length attributes Show length attributes

      • min number Required

        Default value is 8.

      • max number Required

        Default value is 256.

    • characterTypes object

      Default value is {} (empty).

      Hide characterTypes attribute Show characterTypes attribute

      • min number Required

        Default value is 1.

    • rejects object

      Default value is {} (empty).

      Hide rejects attributes Show rejects attributes

      • pwned boolean Required

        Default value is true.

      • repetitionAndSequence boolean Required

        Default value is true.

      • userInfo boolean Required

        Default value is true.

      • words array[string] Required

        Default value is [] (empty).

  • mfa object Required
    Hide mfa attributes Show mfa attributes

    • factors array[string] Required

      Values are Totp, WebAuthn, or BackupCode.

    • policy string Required

      Values are UserControlled or Mandatory.

  • singleSignOnEnabled boolean Required
  • socialConnectors array[object] Required
    Hide socialConnectors attributes Show socialConnectors attributes object

    • id string Required
    • target string Required
    • name object Required

      Validator function

    • description object Required

      Validator function

    • logo string Required
    • logoDark string | null Required
    • readme string Required
    • configTemplate string
    • formItems array[object]
      One of:

      object-1 object object-2 object

      Hide attributes Show attributes

      • type string("Select") Required
      • selectItems array[object] Required
        Hide selectItems attributes Show selectItems attributes object

        • value string Required
        • title string Required
      • key string Required
      • label string Required
      • placeholder string
      • required boolean
      • defaultValue
      • showConditions array[object]
        Hide showConditions attributes Show showConditions attributes object

        • targetKey string Required
        • expectValue
      • description string
      • tooltip string
      • isConfidential boolean

      Hide attributes Show attributes

      • type string Required

        Values are Text, Number, MultilineText, Switch, or Json.

      • key string Required
      • label string Required
      • placeholder string
      • required boolean
      • defaultValue
      • showConditions array[object]
        Hide showConditions attributes Show showConditions attributes object

        • targetKey string Required
        • expectValue
      • description string
      • tooltip string
      • isConfidential boolean
    • platform string | null Required

      Values are Native, Universal, or Web.

    • isStandard boolean
  • ssoConnectors array[object] Required
    Hide ssoConnectors attributes Show ssoConnectors attributes object

    • id string Required
    • connectorName string Required
    • logo string Required
    • darkLogo string
  • forgotPassword object Required
    Hide forgotPassword attributes Show forgotPassword attributes

    • phone boolean Required
    • email boolean Required
  • isDevelopmentTenant boolean Required