Sign-in experience

Update default sign-in experience settings

Changed on

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

patch/api/sign-in-exp

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/sign-in-exp
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Query parameters

removeUnusedDemoSocialConnectorstring

Whether to remove unused demo social connectors. (These demo social connectors are only used during cloud user onboarding)

Request body

tenantIdstring
hideLogtoBrandingboolean

Cloud only. Whether to hide the Logto branding on hosted sign-in pages.

agreeToTermsPolicy'Automatic' | 'ManualRegistrationOnly' | 'Manual'
socialSignInConnectorTargetsstring[]

Specify the social sign-in connectors to display on the sign-in page.

signInMode'SignIn' | 'Register' | 'SignInAndRegister'
customCssstring nullable
customContentobject

Custom content to display on experience flow pages. the page pathname will be the config key, the content will be the config value.

singleSignOnEnabledboolean
ssoBrandingBeforeEmailMatchboolean

Whether to include SSO connector branding (display name and logos) in the public sign-in experience before an email domain matches. Defaults to true.

forgotPasswordMethodsstring[] nullable
usernamePolicyobject

Validator function

Response

Updated default sign-in experience settings.

tenantIdstring required
idstring required
hideLogtoBrandingboolean required
termsOfUseUrlstring nullable required
privacyPolicyUrlstring nullable required
agreeToTermsPolicy'Automatic' | 'ManualRegistrationOnly' | 'Manual' required
socialSignInConnectorTargetsstring[] required
signInMode'SignIn' | 'Register' | 'SignInAndRegister' required
customCssstring nullable required
customContentobject required
singleSignOnEnabledboolean required
ssoBrandingBeforeEmailMatchboolean required
supportEmailstring nullable required
supportWebsiteUrlstring nullable required
unknownSessionRedirectUrlstring nullable required
forgotPasswordMethodsstring[] nullable required
usernamePolicyobject required

Validator function

Changes

  • beed1405186aRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 5768a9ce87dbRevision changes
    • warning

      added the new es-MX enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new es-MX enum value to the request property /

    • info

      added the required property to the response with the status