Type Alias ExternalIdpClient

Reusable client for external IdP operations in Journey and DaVinci flows.

type ExternalIdpClient = {
    authorizeForDaVinci(
        daVinci: DaVinciInstance,
        options?: ExternalIdpAuthorizeOptions,
    ): Promise<void>;
    authorizeForJourney(
        journey: JourneyInstance,
        options?: ExternalIdpAuthorizeOptions,
    ): Promise<ExternalIdpResult>;
    selectProviderForJourney(
        journey: JourneyInstance,
        provider: string,
        options?: ExternalIdpSelectOptions,
    ): Promise<void>;
}

Index

Methods

authorizeForDaVinci authorizeForJourney selectProviderForJourney

Methods

authorizeForDaVinci

authorizeForDaVinci(
daVinci: DaVinciInstance,
options?: ExternalIdpAuthorizeOptions,
): Promise<void>
Launches the external IdP authorization flow for a DaVinci-scoped IdpCollector.

Architecturally different from Journey: the IdP token flows through daVinci.next({ collectors: [] }) via the native RequestInterceptor mechanism — this call does NOT return the token directly. Call daVinci.next() immediately after this resolves to advance the flow.
Parameters
- daVinci: DaVinciInstance
  Active DaVinci instance.
- Optionaloptions: ExternalIdpAuthorizeOptions
  Optional per-call authorize options (index).
Returns Promise<void>
A promise that resolves to void when the IdP redirect is complete.

Remarks
No selectProviderForDaVinci equivalent exists — each social login option is its own IdpCollector with idpId/idpType/label pre-set. The index option handles the rare case of multiple IdpCollector instances on the same node.

Throws
ExternalIdpError when authorization fails.
- Defined in packages/external-idp/src/types/externalIdp.types.ts:140

authorizeForJourney

authorizeForJourney(
journey: JourneyInstance,
options?: ExternalIdpAuthorizeOptions,
): Promise<ExternalIdpResult>
Launches the external IdP authorization flow for a Journey-scoped IdpCallback.

The native SDK handles the redirect internally — no JS-side deep-link listener or journey.resume(uri) call is needed. On success, the callback's internal input state is populated so journey.next({}) picks up the token.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- Optionaloptions: ExternalIdpAuthorizeOptions
  Optional per-call authorize options (index).
Returns Promise<ExternalIdpResult>
A promise that resolves to the authorize result (token, additionalParameters).

Throws
ExternalIdpError when authorization fails.
- Defined in packages/external-idp/src/types/externalIdp.types.ts:99

selectProviderForJourney

selectProviderForJourney(
    journey: JourneyInstance,
    provider: string,
    options?: ExternalIdpSelectOptions,
): Promise<void>
Mutates the native SelectIdpCallback state for a Journey-scoped callback.

Must be called before journey.next({}) — calling next() with a SelectIdPCallback entry directly always throws MissingIntegrationException / missingIntegration from JourneyCallbackValueApplier on both platforms.
Parameters
- journey: JourneyInstance
  Active Journey instance.
- provider: string
  The provider identifier chosen by the user (e.g. 'google').
- Optionaloptions: ExternalIdpSelectOptions
  Optional per-call select options (index).
Returns Promise<void>
Throws
ExternalIdpError when the callback cannot be resolved.
- Defined in packages/external-idp/src/types/externalIdp.types.ts:116