Skip to main content

@authgear/capacitor / ConfigureOptions

Interface: ConfigureOptions

Table of contents

Properties

Properties

clientID

clientID: string

The OAuth client ID.

Defined in

packages/authgear-capacitor/index.d.ts:843


endpoint

endpoint: string

The endpoint.

Defined in

packages/authgear-capacitor/index.d.ts:847


isSSOEnabled

Optional isSSOEnabled: boolean

Single-sign-on (SSO) is defined as login once, logged in all apps. When isSSOEnabled is true, users only need to enter their authentication credentials once. When the user login the second app, they will see the continue screen so that they can log in with just a click. Logout from one app will also logout from all the apps.

Default Value

false

Defined in

packages/authgear-capacitor/index.d.ts:859


preAuthenticatedURLEnabled

Optional preAuthenticatedURLEnabled: boolean

When preAuthenticatedURLEnabled is true, native apps can share session with a web browser.

Default Value

false

Defined in

packages/authgear-capacitor/index.d.ts:864


tokenStorage

Optional tokenStorage: TokenStorage

An implementation of TokenStorage.

Defined in

packages/authgear-capacitor/index.d.ts:851


uiImplementation

Optional uiImplementation: UIImplementation

Defined in

packages/authgear-capacitor/index.d.ts:865