Skip to main content

The Backend Instance object

  • Name
    allowedOrigins
    Type
    null | string[]
    Description

    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 using @clerk/electron, the origins are the custom renderer scheme registered with createClerkBridge(), for example my-app://renderer, and, during development, the renderer's dev server origin, for example http://localhost:5173. For Capacitor.js, the origin is capacitor://localhost.

  • Name
    environmentType
    Type
    string
    Description

    The type of instance environment, either 'production' or 'development'.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the instance.

Feedback

What did you think of this content?

Last updated on