Update default sign-in experience settings

PATCH /api/sign-in-exp

Update the default sign-in experience settings with the provided data.

Query parameters

application/json

Body Required

  • color object

    Specify the primary branding color for the sign-in page (both light/dark mode).

    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
    Hide branding attributes Show branding attributes
  • Control the language detection policy for the sign-in page.

    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.

  • signIn object

    Sign-in method settings

    Hide signIn attribute Show signIn attribute
  • signUp object

    Sign-up method settings

    Hide signUp attributes Show signUp attributes
    • identifiers array[string] Required

      Specify allowed identifiers when signing-up.

      Values are username, email, or phone.

    • password boolean Required

      Whether the user is required to set a password when signing-up.

    • verify boolean Required

      Whether the user is required to verify their email/phone when signing-up.

  • Hide socialSignIn attribute Show socialSignIn attribute
  • Specify the social sign-in connectors to display on the sign-in page.

  • Values are SignIn, Register, or SignInAndRegister.

  • customCss string | null
  • Custom content to display on experience flow pages. the page pathname will be the config key, the content will be the config value.

    Hide customContent attributes Show customContent attributes
  • Password policies to adjust the password strength requirements.

    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.

    • 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
  • mfa object

    MFA settings

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

      Values are Totp, WebAuthn, or BackupCode.

    • policy string Required

      Values are UserControlled or Mandatory.

Responses

  • 200 application/json

    Updated default sign-in experience settings.

    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
    • 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
    • signUp object Required
      Hide signUp attributes Show signUp attributes
    • socialSignIn object Required
      Hide socialSignIn attribute Show socialSignIn attribute
    • 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
    • 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.

      • 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
    • 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
  • 400

    Bad request. Invalid data provided.

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Default sign-in experience settings not found.

  • 422

    Unprocessable Entity. Invalid data provided.

PATCH /api/sign-in-exp
curl \
 -X PATCH https://[tenant_id].logto.app/api/sign-in-exp \
 -H "Content-Type: application/json" \
 -d '{"color":{"primaryColor":"string","isDarkModeEnabled":true,"darkPrimaryColor":"string"},"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string"},"languageInfo":{"autoDetect":true,"fallbackLanguage":"af-ZA"},"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":{"key":"string"},"passwordPolicy":{"length":{"min":8,"max":256},"characterTypes":{"min":1},"rejects":{"pwned":true,"repetitionAndSequence":true,"userInfo":true,"words":[]}},"mfa":{"factors":["Totp"],"policy":"UserControlled"},"singleSignOnEnabled":true,"termsOfUseUrl":"string","privacyPolicyUrl":"string"}'
Request examples
{
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string"
  },
  "languageInfo": {
    "autoDetect": true,
    "fallbackLanguage": "af-ZA"
  },
  "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": {
    "key": "string"
  },
  "passwordPolicy": {
    "length": {
      "min": 8,
      "max": 256
    },
    "characterTypes": {
      "min": 1
    },
    "rejects": {
      "pwned": true,
      "repetitionAndSequence": true,
      "userInfo": true,
      "words": []
    }
  },
  "mfa": {
    "factors": [
      "Totp"
    ],
    "policy": "UserControlled"
  },
  "singleSignOnEnabled": true,
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string"
}
Response examples (200)
{
  "id": "string",
  "color": {
    "primaryColor": "string",
    "isDarkModeEnabled": true,
    "darkPrimaryColor": "string"
  },
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string"
  },
  "languageInfo": {
    "autoDetect": true,
    "fallbackLanguage": "af-ZA"
  },
  "termsOfUseUrl": "string",
  "privacyPolicyUrl": "string",
  "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": {
    "key": "string"
  },
  "passwordPolicy": {
    "length": {
      "min": 8,
      "max": 256
    },
    "characterTypes": {
      "min": 1
    },
    "rejects": {
      "pwned": true,
      "repetitionAndSequence": true,
      "userInfo": true,
      "words": []
    }
  },
  "mfa": {
    "factors": [
      "Totp"
    ],
    "policy": "UserControlled"
  },
  "singleSignOnEnabled": true
}