Skip to content

Latest commit

 

History

History
16 lines (13 loc) · 20.9 KB

UpdateInstanceRequestBody.md

File metadata and controls

16 lines (13 loc) · 20.9 KB

UpdateInstanceRequestBody

Fields

Field Type Required Description Example
TestMode bool ➖ Toggles test mode for this instance, allowing the use of test email addresses and phone numbers.
Defaults to true for development instances.		 true
Hibp bool ➖ Whether the instance should be using the HIBP service to check passwords for breaches false
EnhancedEmailDeliverability bool ➖ The "enhanced_email_deliverability" feature will send emails from "[email protected]" instead of your domain.
This can be helpful if you do not have a high domain reputation.		 true
SupportEmail string ➖ N/A [email protected]
ClerkJsVersion string ➖ N/A 2.3.1
DevelopmentOrigin string ➖ N/A http://localhost:3000
AllowedOrigins List<string> ➖ 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.
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.		 [
"http://localhost:3000",
"chrome-extension://extension_uiid",
"capacitor://localhost"
]
CookielessDev bool ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether the instance should operate in cookieless development mode (i.e. without third-party cookies).
Deprecated: Please use url_based_session_syncing instead.		 false
UrlBasedSessionSyncing bool ➖ Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies). true