Class Auth

constructor

• new Auth(config): Auth

• Create a new Auth instance

  Parameters

  • config: AuthModuleConfiguration

    Auth configuration

  Returns Auth

  Example

  import { Auth } from '@imtbl/auth';
  
  const auth = new Auth({
    authenticationDomain: 'https://auth.immutable.com',
    passportDomain: 'https://passport.immutable.com',
    clientId: 'your-client-id',
    redirectUri: 'https://your-app.com/callback',
    scope: 'openid profile email transact',
  });
  Copy

ReadonlyeventEmitter

login

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

• Login the user with extended options Supports cached sessions, silent login, redirect flow, and direct login

  Parameters

  • Optionaloptions: LoginOptions

    Extended login options

  Returns Promise<null | User>

  Promise that resolves with the user or null

loginWithRedirect

• loginWithRedirect(directLoginOptions?): Promise<void>

• Login with redirect Redirects the page for authentication

  Parameters

  • OptionaldirectLoginOptions: auth.DirectLoginOptions

    Optional direct login options

  Returns Promise<void>

  Promise that resolves when redirect is initiated

loginCallback

• loginCallback(): Promise<undefined | User>

• Login callback handler Call this in your redirect or popup callback page

  Returns Promise<undefined | User>

  Promise that resolves with the authenticated user or undefined (for popup flows)

logout

• logout(): Promise<void>

• Logout the current user

  Returns Promise<void>

  Promise that resolves when logout is complete

getUser

• getUser(): Promise<null | User>

• Get the current authenticated user

  Returns Promise<null | User>

  Promise that resolves with the user or null if not authenticated

getUserOrLogin

• getUserOrLogin(): Promise<User>

• Get the current authenticated user or initiate login if needed

  Returns Promise<User>

  Promise that resolves with an authenticated user

getUserZkEvm

• getUserZkEvm(): Promise<UserZkEvm>

• Get the current authenticated zkEVM user

  Returns Promise<UserZkEvm>

  Promise that resolves with a zkEVM-capable user

getIdToken

• getIdToken(): Promise<undefined | string>

• Get the ID token for the current user

  Returns Promise<undefined | string>

  Promise that resolves with the ID token or undefined

getAccessToken

• getAccessToken(): Promise<undefined | string>

• Get the access token for the current user

  Returns Promise<undefined | string>

  Promise that resolves with the access token or undefined

isLoggedIn

• isLoggedIn(): Promise<boolean>

• Check if user is logged in

  Returns Promise<boolean>

  Promise that resolves with true if user is logged in

forceUserRefresh

• forceUserRefresh(): Promise<null | User>

• Force a silent user refresh (for silent login)

  Returns Promise<null | User>

  Promise that resolves with the user or null if refresh fails

forceUserRefreshInBackground

• forceUserRefreshInBackground(): void

• Trigger a background user refresh without awaiting the result

  Returns void

loginWithPKCEFlow

• loginWithPKCEFlow(directLoginOptions?, imPassportTraceId?): Promise<string>

• Get the PKCE authorization URL for login flow

  Parameters

  • OptionaldirectLoginOptions: auth.DirectLoginOptions

    Optional direct login options
  • OptionalimPassportTraceId: string

    Optional trace ID for tracking

  Returns Promise<string>

  Promise that resolves with the authorization URL

loginWithPKCEFlowCallback

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

• Handle the PKCE login callback

  Parameters

  • authorizationCode: string

    The authorization code from the OAuth provider
  • state: string

    The state parameter for CSRF protection

  Returns Promise<User>

  Promise that resolves with the authenticated user

storeTokens

• storeTokens(tokenResponse): Promise<User>

• Store tokens from device flow and retrieve user

  Parameters

  • tokenResponse: DeviceTokenResponse

    The token response from device flow

  Returns Promise<User>

  Promise that resolves with the authenticated user

getLogoutUrl

• getLogoutUrl(): Promise<undefined | string>

• Get the logout URL

  Returns Promise<undefined | string>

  Promise that resolves with the logout URL or undefined if not available

logoutSilentCallback

• logoutSilentCallback(url): Promise<void>

• Handle the silent logout callback

  Parameters

  • url: string

    The URL containing logout information

  Returns Promise<void>

  Promise that resolves when callback is handled

getConfig

• getConfig(): IAuthConfiguration
• Internal

  Get auth configuration

  Returns IAuthConfiguration

  IAuthConfiguration instance

getClientId

• getClientId(): Promise<string>

• Get the configured OIDC client ID

  Returns Promise<string>

  Promise that resolves with the client ID string