# Update default sign-in experience settings

**PATCH /api/sign-in-exp**

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


## Servers
- Logto endpoint address.: https://[tenant_id].logto.app (Logto endpoint address.)


## Authentication methods
- O auth2


## Parameters


### Query parameters
- **removeUnusedDemoSocialConnector** (string)
  Whether to remove unused demo social connectors. (These demo social connectors are only used during cloud user onboarding)

### Body: application/json (object)

- **tenantId** (string)

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

- **hideLogtoBranding** (boolean)
  Cloud only. Whether to hide the Logto branding on hosted sign-in pages.
- **languageInfo** (object)
  Control the language detection policy for the sign-in page.
- **agreeToTermsPolicy** (string)

- **signIn** (object)
  Sign-in method settings
- **signUp** (object)
  Sign-up method settings
- **socialSignIn** (object)

- **socialSignInConnectorTargets** (array[string])
  Specify the social sign-in connectors to display on the sign-in page.
- **signInMode** (string)

- **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.
- **forgotPasswordMethods** (array[string] | null)

- **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.


## Responses
### 200
Updated default sign-in experience settings.

#### Body: application/json (object)
- **tenantId** (string)

- **id** (string)

- **color** (object)

- **branding** (object)

- **hideLogtoBranding** (boolean)

- **languageInfo** (object)

- **termsOfUseUrl** (string | null)

- **privacyPolicyUrl** (string | null)

- **agreeToTermsPolicy** (string)

- **signIn** (object)

- **signUp** (object)

- **socialSignIn** (object)

- **socialSignInConnectorTargets** (array[string])

- **signInMode** (string)

- **customCss** (string | null)

- **customContent** (object)

- **customUiAssets** (object | null)

- **passwordPolicy** (object)

- **mfa** (object)

- **singleSignOnEnabled** (boolean)

- **supportEmail** (string | null)

- **supportWebsiteUrl** (string | null)

- **unknownSessionRedirectUrl** (string | null)

- **captchaPolicy** (object)

- **sentinelPolicy** (object)

- **emailBlocklistPolicy** (object)

- **forgotPasswordMethods** (array[string] | null)


### 400
Bad request. Invalid data provided.

### 401
Unauthorized

### 403
Forbidden

### 404
Default sign-in experience settings not found.

### 422
Unprocessable Entity. Invalid data provided.


[Powered by Bump.sh](https://bump.sh)