Class AdminUser

constructor

• new AdminUser(
      __namedParameters: { sessionData: SessionsResponse | null },
  ): AdminUser

  Parameters

  • __namedParameters: { sessionData: SessionsResponse | null }

  Returns AdminUser

sessionData

StaticallowedUserTypes

StaticsessionCookieName

avatar

• get avatar(): string | null

  Returns string | null

bearerToken

• get bearerToken(): string | null

  Returns string | null

email

• get email(): string | null

  Returns string | null

encryptedCookieToken

• get encryptedCookieToken(): string | null

  Returns string | null

firstName

• get firstName(): string | null

  Returns string | null

id

• get id(): number | null

  Returns number | null

lastName

• get lastName(): string | null

  Returns string | null

refreshToken

• get refreshToken(): string | null

  Returns string | null

sessionCookie

• get sessionCookie(): SessionCookie | null

  Returns SessionCookie | null

tokenExpiry

• get tokenExpiry(): string | null

  Returns string | null

type

• get type(): string | null

  Returns string | null

signOut

• signOut(): Promise<void>

  Returns Promise<void>

Staticcurrent

• current(domain: string): Promise<AdminUser | null>

  Parameters

  • domain: string

  Returns Promise<AdminUser | null>

StaticisAdminUser

• isAdminUser(user: UserData | undefined, domain: string): boolean

  Parameters

  • user: UserData | undefined
  • domain: string

  Returns boolean

StaticsignIn

• signIn(
      __namedParameters: { domain: string; email: string; password: string },
  ): Promise<{ error: unknown; result: AdminUser | null }>

  Parameters

  • __namedParameters: { domain: string; email: string; password: string }

  Returns Promise<{ error: unknown; result: AdminUser | null }>

StaticverifySession

• verifySession(
      encryptedCookieToken: string,
      domain: string,
  ): Promise<AdminUser | null>

  Admin user session verification requires a Bearer token (app verification) via staging users api if in a staging environment. This differs from other flows that always require a Bearer token from production, regardless of environment. This is handled in the users-api-session-helper.ts.

  Parameters

  • encryptedCookieToken: string
  • domain: string

  Returns Promise<AdminUser | null>