ConfigureOptions

@authgear/web

---

@authgear/web / ConfigureOptions

Interface: ConfigureOptions

Properties

clientID

clientID: string

The OAuth client ID.

---

endpoint

endpoint: string

The endpoint.

---

fetch?

optional fetch: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; (input, init?): Promise<Response>; } & {(input, init?): Promise<Response>; (input, init?): Promise<Response>; (input, init?): Promise<Response>; (input, init?): Promise<Response>; }

---

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.

This flag is used when sessionType is "refresh_token" only. When sessionType is "cookie", sessions are shared among subdomains and this flag is not needed.

Default Value

false

---

sessionType?

optional sessionType: "cookie" | "refresh_token"

sessionType indicates how session is supposed to be stored. This must match the server side configuration.

If your backend is a server-side rendering website or webapp, then you should use cookie.

Normally, you need to set up a custom domain so that your backend and Authgear can both read and write cookie in the same root domain. You also need to tell the SDK cookie is being used, by specifying "cookie" here.

If not specified, default to "refresh_token".