Skip to content

PrepareSsoParamsType

PrepareSsoParamsType = { directExit?: boolean; lang?: "en" | "fr"; metadata?: SsoMetadata; redirectUrl?: string; }

Defined in: types/rpc/sso.ts:22

Params for preparing SSO (generating URL) Same as OpenSsoParamsType but without openInSameWindow (popup-only operation)

optional directExit?: boolean

Defined in: types/rpc/sso.ts:35

If the SSO should directly exit (close the popup) after completion.

Defaults to true when redirectUrl is omitted, false otherwise. The default is applied by `openSso()` before the SSO URL is generated and by the wallet SSO route as a fallback for older SDK callers.


optional lang?: "en" | "fr"

Defined in: types/rpc/sso.ts:40

Language of the SSO page (optional) It will default to the current user language (or “en” if unsupported language)


optional metadata?: SsoMetadata

Defined in: types/rpc/sso.ts:44

Custom SSO metadata


optional redirectUrl?: string

Defined in: types/rpc/sso.ts:26

Redirect URL after the SSO (optional)