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
termsOfUseUrl string(url) | null | string(empty)
privacyPolicyUrl string(url) | null | string(empty)
PATCH
/api/sign-in-exp
curl \
-X PATCH https://[tenant_id].logto.app/api/sign-in-exp \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"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},"socialSignIn":{"automaticAccountLinking":true},"socialSignInConnectorTargets":["string"],"signInMode":"SignIn","customCss":"string","customContent":{"key":"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,"termsOfUseUrl":"string","privacyPolicyUrl":"string"}'
Request examples
{
"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
},
"socialSignIn": {
"automaticAccountLinking": true
},
"socialSignInConnectorTargets": [
"string"
],
"signInMode": "SignIn",
"customCss": "string",
"customContent": {
"key": "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,
"termsOfUseUrl": "string",
"privacyPolicyUrl": "string"
}
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": {
"key": "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
}