Class Passport

Constructors

constructor

Methods

connectImxSilent connectImx connectEvm login loginCallback loginWithDeviceFlow loginWithDeviceFlowCallback loginWithPKCEFlow loginWithPKCEFlowCallback logout logoutDeviceFlow logoutSilentCallback getUserInfo getIdToken getAccessToken getLinkedAddresses linkExternalWallet

Constructors

constructor

Methods

connectImxSilent

  • connectImxSilent(): Promise<null | IMXProvider>

  • Returns Promise<null | IMXProvider>

    Deprecated

    The method login with an argument of { useCachedSession: true } should be used in conjunction with connectImx instead.

connectImx

  • connectImx(): Promise<IMXProvider>

  • Returns Promise<IMXProvider>

connectEvm

  • connectEvm(options?): Provider

  • Parameters

    • Optionaloptions: {
          announceProvider: boolean;
      }
      • announceProvider: boolean

    Returns Provider

login

  • login(options?): Promise<null | UserProfile>

  • Initiates the authorisation flow.

    Parameters

    • Optionaloptions: {
          useCachedSession: boolean;
          anonymousId?: string;
      }
      • useCachedSession: boolean

        = false - If true, and no active session exists, then the user will not be prompted to log in and the Promise will resolve with a null value.

      • OptionalanonymousId?: string

        If provided, Passport internal metrics will be enriched with this value.

    Returns Promise<null | UserProfile>

    the user profile if the user is logged in, otherwise null

loginCallback

  • loginCallback(): Promise<void>

  • Returns Promise<void>

loginWithDeviceFlow

  • loginWithDeviceFlow(options?): Promise<DeviceConnectResponse>

  • Parameters

    • Optionaloptions: {
          anonymousId?: string;
      }
      • OptionalanonymousId?: string

    Returns Promise<DeviceConnectResponse>

loginWithDeviceFlowCallback

  • loginWithDeviceFlowCallback(deviceCode, interval, timeoutMs?): Promise<UserProfile>

  • Parameters

    • deviceCode: string
    • interval: number
    • OptionaltimeoutMs: number

    Returns Promise<UserProfile>

loginWithPKCEFlow

  • loginWithPKCEFlow(): string

  • Returns string

loginWithPKCEFlowCallback

  • loginWithPKCEFlowCallback(authorizationCode, state): Promise<UserProfile>

  • Parameters

    • authorizationCode: string
    • state: string

    Returns Promise<UserProfile>

logout

  • logout(): Promise<void>

  • Returns Promise<void>

logoutDeviceFlow

  • logoutDeviceFlow(): Promise<string>

  • Logs the user out of Passport when using device flow authentication.

    Returns Promise<string>

    The device flow end session endpoint. Consumers are responsible for opening this URL in the same browser that was used to log the user in.

logoutSilentCallback

  • logoutSilentCallback(url): Promise<void>

  • This method should only be called from the logout redirect uri when logout mode is 'silent'.

    Parameters

    • url: string

    Returns Promise<void>

getUserInfo

  • getUserInfo(): Promise<undefined | UserProfile>

  • Returns Promise<undefined | UserProfile>

getIdToken

  • getIdToken(): Promise<undefined | string>

  • Returns Promise<undefined | string>

getAccessToken

  • getAccessToken(): Promise<undefined | string>

  • Returns Promise<undefined | string>

getLinkedAddresses

  • getLinkedAddresses(): Promise<string[]>

  • Returns Promise<string[]>

linkExternalWallet

Settings

Member Visibility

On This Page

Constructors
Methods