Hierarchy

  • Passport

Constructors

Properties

authManager: any
config: any
confirmationScreen: any
immutableXClient: any
magicAdapter: any
multiRollupApiClients: any
passportImxProviderFactory: any
passportEventEmitter: any
guardianClient: any

Methods

  • Returns Promise<null | x.IMXProvider>

    Deprecated

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

  • Returns Promise<x.IMXProvider>

  • 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

  • Returns Promise<void>

  • Parameters

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

    Returns Promise<passport.UserProfile>

  • Returns string

  • Parameters

    • authorizationCode: string
    • state: string

    Returns Promise<passport.UserProfile>

  • Returns Promise<void>

  • 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.

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

    Parameters

    • url: string

    Returns Promise<void>

  • Returns Promise<undefined | string>

  • Returns Promise<undefined | string>

  • Returns Promise<string[]>

Generated using TypeDoc