Class Passport

Hierarchy

  • Passport

Constructors

constructor

Properties

authManager config confirmationScreen immutableXClient magicAdapter multiRollupApiClients passportImxProviderFactory passportEventEmitter guardianClient

Methods

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

Constructors

constructor

Properties

Private Readonly authManager

authManager: any

Private Readonly config

config: any

Private Readonly confirmationScreen

confirmationScreen: any

Private Readonly immutableXClient

immutableXClient: any

Private Readonly magicAdapter

magicAdapter: any

Private Readonly multiRollupApiClients

multiRollupApiClients: any

Private Readonly passportImxProviderFactory

passportImxProviderFactory: any

Private Readonly passportEventEmitter

passportEventEmitter: any

Private Readonly guardianClient

guardianClient: any

Methods

connectImxSilent

  • Returns Promise<null | x.IMXProvider>

    Deprecated

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

connectImx

  • Returns Promise<x.IMXProvider>

connectEvm

  • Parameters

    • Optional options: {
          announceProvider: boolean;
      }
      • announceProvider: boolean

    Returns passport.Provider

login

  • Initiates the authorisation flow.

    Parameters

    • Optional options: {
          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.

      • Optional anonymousId?: string

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

    Returns Promise<null | passport.UserProfile>

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

loginCallback

  • Returns Promise<void>

loginWithDeviceFlow

loginWithDeviceFlowCallback

  • Parameters

    • deviceCode: string
    • interval: number
    • Optional timeoutMs: number

    Returns Promise<passport.UserProfile>

loginWithPKCEFlow

  • Returns string

loginWithPKCEFlowCallback

  • Parameters

    • authorizationCode: string
    • state: string

    Returns Promise<passport.UserProfile>

logout

  • Returns Promise<void>

logoutDeviceFlow

  • 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

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

    Parameters

    • url: string

    Returns Promise<void>

getUserInfo

getIdToken

  • Returns Promise<undefined | string>

getAccessToken

  • Returns Promise<undefined | string>

getLinkedAddresses

  • Returns Promise<string[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc