Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / AuthApi

Class: AuthApi

Table of contents

Constructors

Methods

Constructors

constructor

new AuthApi(apiClient): AuthApi

Parameters

NameType
apiClientPersApiClient

Returns

AuthApi

Defined in

core/auth/api/auth-api.ts:41

Methods

loginTenantAdmin

loginTenantAdmin(jwt, options?): Promise<SessionAuthContextResponseDTO>

Login tenant admin with JWT

Authenticates an admin in a tenant context.

Parameters

NameTypeDescription
jwtstringAuthentication token (Firebase JWT)
options?TenantAuthOptionsTenant authentication options (tenantId for multi-tenant admins)

Returns

Promise<SessionAuthContextResponseDTO>

Session response with tenant context

Throws

MultipleContextSelectionError when tenantId is required but not provided

Example

// Single tenant - auto-selects
const response = await authApi.loginTenantAdmin(jwt);

// Multiple tenants - explicit selection
const response = await authApi.loginTenantAdmin(jwt, { tenantId: 'tenant-123' });

Defined in

core/auth/api/auth-api.ts:62


loginUser

loginUser(jwt): Promise<SessionAuthContextResponseDTO>

Login user with JWT

Parameters

NameType
jwtstring

Returns

Promise<SessionAuthContextResponseDTO>

Defined in

core/auth/api/auth-api.ts:74


loginBusiness

loginBusiness(jwt, options?): Promise<SessionAuthContextResponseDTO>

Login as business with JWT

Authenticates a user in a business context with role included in JWT.

Parameters

NameTypeDescription
jwtstringAuthentication token (passkey or Firebase JWT)
options?BusinessAuthOptionsBusiness authentication options (businessId for multi-business users, auto-selected if single membership)

Returns

Promise<SessionAuthContextResponseDTO>

Session response with business context and role in JWT

Throws

MultipleContextSelectionError when businessId is required but not provided

Example

// Single business membership - auto-selects
const response = await authApi.loginBusiness(jwt);

// Multiple memberships - explicit selection
const response = await authApi.loginBusiness(jwt, { businessId: 'biz-123' });

Defined in

core/auth/api/auth-api.ts:101


loginUnAuthenticated

loginUnAuthenticated(rawLoginData): Promise<SessionAuthContextResponseDTO>

Login user with raw data (no external authentication)

Parameters

NameType
rawLoginDataRecord<string, any>

Returns

Promise<SessionAuthContextResponseDTO>

Defined in

core/auth/api/auth-api.ts:113


refreshAccessToken

refreshAccessToken(refreshToken): Promise<SessionAuthResponseDTO>

Refresh access token

Parameters

NameType
refreshTokenstring

Returns

Promise<SessionAuthResponseDTO>

Defined in

core/auth/api/auth-api.ts:125


getCurrentUser

getCurrentUser(): Promise<UserDTO>

Get current authenticated user

Returns

Promise<UserDTO>

Defined in

core/auth/api/auth-api.ts:139


getCurrentBusiness

getCurrentBusiness(): Promise<BusinessDTO>

Get current business context

Returns

Promise<BusinessDTO>

Defined in

core/auth/api/auth-api.ts:146


getCurrentAdmin

getCurrentAdmin(): Promise<AdminDTO>

Get current admin context

Returns

Promise<AdminDTO>

Defined in

core/auth/api/auth-api.ts:153