Hierarchy

  • Passport

Constructors

Properties

authManager: default
config: PassportConfiguration
confirmationScreen: default
immutableXClient: x.IMXClient
magicAdapter: default
multiRollupApiClients: MultiRollupApiClients
passportImxProviderFactory: PassportImxProviderFactory
passportEventEmitter: default<PassportEventMap>
guardianClient: default

Methods

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

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

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

Generated using TypeDoc