Skip to content
Docs

getAuthDetails

getAuthDetails returns the details about the authenticated user, specifically the EOA address of the user, and the encrypted headers used to authenticate / manage the user's account.

This method must be called after authenticate. Otherwise, this method will throw an error with the message Not Authenticated.

Usage

example.ts
import { createPassportSigner } from "./passport";

const passportSigner = await createPassportSigner();
 
const details = await passportSigner.getAuthDetails();

Returns

Promise<PassportUserInfo>

A Promise containing the PassportUserInfo, an object with the following fields:

  • authenticatedHeaders: PassportAuthenticatedHeaders -- Headers that include encrypted key and session information.

    • x-encrypted-key: string -- The encrypted key header.
    • x-session: string -- The session header.

  • addresses: Address[] -- An array of blockchain addresses associated with the user.