Update default sign-in experience settings
Update the default sign-in experience settings with the provided data.
Body
Required
-
tenantId
string Maximum length is
21
. -
color
object Specify the primary branding color for the sign-in page (both light/dark mode).
-
branding
object -
languageInfo
object Control the language detection policy for the sign-in page.
-
agreeToTermsPolicy
string Values are
Automatic
,ManualRegistrationOnly
, orManual
. -
signIn
object Sign-in method settings
-
signUp
object Sign-up method settings
-
signInMode
string Values are
SignIn
,Register
, orSignInAndRegister
. -
customCss
string | null -
customContent
object Custom content to display on experience flow pages. the page pathname will be the config key, the content will be the config value.
-
customUiAssets
object | null -
passwordPolicy
object Password policies to adjust the password strength requirements.
-
mfa
object MFA settings
-
singleSignOnEnabled
boolean -
captchaPolicy
object -
sentinelPolicy
object Custom sentinel policy settings. Use this field to customize the user lockout policy. The default value is 100 failed attempts within one hour. The user will be locked out for 60 minutes after exceeding the limit.
-
emailBlocklistPolicy
object Define email restriction policies. Users will be prohibited from registering or linking any email addresses that are included in the blocklist.
termsOfUseUrl
string(url) | null | string(empty) privacyPolicyUrl
string(url) | null | string(empty) supportEmail
string(email) | null | string(empty) The support email address to display on the error pages.
supportWebsiteUrl
string(url) | null | string(empty) The support website URL to display on the error pages.
unknownSessionRedirectUrl
string(url) | null | string(empty) The fallback URL to redirect users when the sign-in session does not exist or unknown. Client should initiate a new authentication flow after the redirection.
curl \
--request PATCH 'https://[tenant_id].logto.app/api/sign-in-exp' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"tenantId":"string","color":{"primaryColor":"string","isDarkModeEnabled":true,"darkPrimaryColor":"string"},"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string","darkFavicon":"string"},"languageInfo":{"autoDetect":true,"fallbackLanguage":"af-ZA"},"agreeToTermsPolicy":"Automatic","signIn":{"methods":[{"identifier":"username","password":true,"verificationCode":true,"isPasswordPrimary":true}]},"signUp":{"identifiers":["username"],"password":true,"verify":true,"secondaryIdentifiers":[{"identifier":"username","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","organizationRequiredMfaPolicy":"NoPrompt"},"singleSignOnEnabled":true,"captchaPolicy":{"enabled":true},"sentinelPolicy":{"maxAttempts":42.0,"lockoutDuration":42.0},"emailBlocklistPolicy":{"blockDisposableAddresses":true,"blockSubaddressing":true,"customBlocklist":["string"]},"termsOfUseUrl":"string","privacyPolicyUrl":"string","supportEmail":"hello@example.com","supportWebsiteUrl":"string","unknownSessionRedirectUrl":"string"}'
{
"tenantId": "string",
"color": {
"primaryColor": "string",
"isDarkModeEnabled": true,
"darkPrimaryColor": "string"
},
"branding": {
"logoUrl": "string",
"darkLogoUrl": "string",
"favicon": "string",
"darkFavicon": "string"
},
"languageInfo": {
"autoDetect": true,
"fallbackLanguage": "af-ZA"
},
"agreeToTermsPolicy": "Automatic",
"signIn": {
"methods": [
{
"identifier": "username",
"password": true,
"verificationCode": true,
"isPasswordPrimary": true
}
]
},
"signUp": {
"identifiers": [
"username"
],
"password": true,
"verify": true,
"secondaryIdentifiers": [
{
"identifier": "username",
"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",
"organizationRequiredMfaPolicy": "NoPrompt"
},
"singleSignOnEnabled": true,
"captchaPolicy": {
"enabled": true
},
"sentinelPolicy": {
"maxAttempts": 42.0,
"lockoutDuration": 42.0
},
"emailBlocklistPolicy": {
"blockDisposableAddresses": true,
"blockSubaddressing": true,
"customBlocklist": [
"string"
]
},
"termsOfUseUrl": "string",
"privacyPolicyUrl": "string",
"supportEmail": "hello@example.com",
"supportWebsiteUrl": "string",
"unknownSessionRedirectUrl": "string"
}
{
"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,
"secondaryIdentifiers": [
{
"identifier": "username",
"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",
"organizationRequiredMfaPolicy": "NoPrompt"
},
"singleSignOnEnabled": true,
"supportEmail": "string",
"supportWebsiteUrl": "string",
"unknownSessionRedirectUrl": "string",
"captchaPolicy": {
"enabled": true
},
"sentinelPolicy": {
"maxAttempts": 42.0,
"lockoutDuration": 42.0
},
"emailBlocklistPolicy": {
"blockDisposableAddresses": true,
"blockSubaddressing": true,
"customBlocklist": [
"string"
]
}
}