Skip to content

SSOConfig

@blobs/sdk v0.1.0


@blobs/sdk / sso / SSOConfig

Defined in: sso/types.ts:27

Caller-supplied options for an SSO flow, merged with DEFAULT_SSO_CONFIG via mergeConfig.

Properties

network?

optional network?: string

Defined in: sso/types.ts:29

Target network for authentication (defaults to SDK default network)


authServer?

optional authServer?: string

Defined in: sso/types.ts:32

Custom auth server URL (overrides network’s hostAuth)


returnUrl?

optional returnUrl?: string

Defined in: sso/types.ts:35

URL to redirect to after successful authentication


signOutUrl?

optional signOutUrl?: string

Defined in: sso/types.ts:38

URL to redirect to on sign out


clientId?

optional clientId?: string

Defined in: sso/types.ts:41

Custom client ID for OAuth flow


scopes?

optional scopes?: string[]

Defined in: sso/types.ts:44

Requested permissions/scopes


permissions?

optional permissions?: string[]

Defined in: sso/types.ts:47

Custom permissions to request


popupOptions?

optional popupOptions?: SSOPopupOptions

Defined in: sso/types.ts:50

Popup window options


onSuccess?

optional onSuccess?: (result) => void

Defined in: sso/types.ts:53

Success callback

Parameters

result

SSOResult

Returns

void


onError?

optional onError?: (error) => void

Defined in: sso/types.ts:56

Error callback

Parameters

error

SSOError

Returns

void


allowSessionSelection?

optional allowSessionSelection?: boolean

Defined in: sso/types.ts:59

Allow selecting from existing sessions


autoClose?

optional autoClose?: boolean

Defined in: sso/types.ts:62

Auto-close popup on success


timeout?

optional timeout?: number

Defined in: sso/types.ts:65

Timeout in milliseconds (default 5 minutes)