Sign-in experience

Get default sign-in experience settings

Changed on

Get the default sign-in experience settings.

get/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)

Response

Default sign-in experience settings.

tenantIdstring required
idstring required
hideLogtoBrandingboolean required

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

termsOfUseUrlstring nullable required
privacyPolicyUrlstring nullable required
agreeToTermsPolicy'Automatic' | 'ManualRegistrationOnly' | 'Manual' required
socialSignInConnectorTargetsstring[] required

Enabled social sign-in connectors, will displayed on the sign-in page.

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

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

singleSignOnEnabledboolean required
ssoBrandingBeforeEmailMatchboolean required

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

supportEmailstring nullable required

The support email address to display on the error pages.

supportWebsiteUrlstring nullable required

The support website URL to display on the error pages.

unknownSessionRedirectUrlstring nullable required

The fallback URL to redirect users when the sign-in session does not exist or unknown. Client should initiates a new authentication flow after the redirection.

forgotPasswordMethodsstring[] nullable required
usernamePolicyobject required

Validator function

Changes

  • beed1405186aRevision changes
    • 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 required property to the response with the status