mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-07 12:27:45 +00:00
16 lines
17 KiB
Markdown
16 lines
17 KiB
Markdown
# UpdateInstanceRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `testMode` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Toggles test mode for this instance, allowing the use of test email addresses and phone numbers.<br/>Defaults to true for development instances. |
|
|
| `hibp` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Whether the instance should be using the HIBP service to check passwords for breaches |
|
|
| `enhancedEmailDeliverability` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | The "enhanced_email_deliverability" feature will send emails from "verifications@clerk.dev" instead of your domain.<br/>This can be helpful if you do not have a high domain reputation. |
|
|
| `supportEmail` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `clerkJsVersion` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `developmentOrigin` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
|
|
| `allowedOrigins` | List<*String*> | :heavy_minus_sign: | For browser-like stacks such as browser extensions, Electron, or Capacitor.js the instance allowed origins need to be updated with the request origin value.<br/>For Chrome extensions popup, background, or service worker pages the origin is chrome-extension://extension_uiid. For Electron apps the default origin is http://localhost:3000. For Capacitor, the origin is capacitor://localhost. |
|
|
| ~~`cookielessDev`~~ | *Optional<? extends Boolean>* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>Whether the instance should operate in cookieless development mode (i.e. without third-party cookies).<br/>Deprecated: Please use `url_based_session_syncing` instead. |
|
|
| `urlBasedSessionSyncing` | *Optional<? extends Boolean>* | :heavy_minus_sign: | Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies). | |