Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / TenantApi

Class: TenantApi

Platform-Agnostic Tenant API Client

Handles tenant and admin operations using the PERS backend. Updated to match new RESTful tenant controller endpoints.

Note: Special header handling (bypass-auth-interceptor) should be handled by PersApiClient internally or through endpoint-specific configuration.

Table of contents

Constructors

Methods

Constructors

constructor

• new TenantApi(apiClient): TenantApi

Parameters

NameType
apiClientPersApiClient

Returns

TenantApi

Defined in

tenant/api/tenant-api.ts:23

Methods

getRemoteTenant

▸ getRemoteTenant(): Promise<TenantDTO>

API KEY + ADMIN JWT: Get full tenant information including sensitive config Uses /tenants/me endpoint with Admin JWT authentication

Requires: X-API-Key header + Authorization Bearer token (Admin JWT) Returns: Full tenant information including allowedTokenIssuers and sensitive config

Returns

Promise<TenantDTO>

Defined in

tenant/api/tenant-api.ts:39


getRemoteTenantPublic

▸ getRemoteTenantPublic(): Promise<TenantPublicDTO>

API KEY: Get current tenant public information Uses /tenants/me endpoint with API key authentication

Requires: X-API-Key header (handled by PersApiClient) Returns: Public tenant information (no sensitive config)

Returns

Promise<TenantPublicDTO>

Defined in

tenant/api/tenant-api.ts:52


getRemoteLoginToken

▸ getRemoteLoginToken(): Promise<string>

API KEY: Get remote login token UPDATED: Requires API key authentication

Returns

Promise<string>

Defined in

tenant/api/tenant-api.ts:62


getRemoteClientConfig

▸ getRemoteClientConfig(): Promise<TenantClientConfigDTO>

API KEY: Get remote client configuration UPDATED: Requires API key authentication

Returns

Promise<TenantClientConfigDTO>

Defined in

tenant/api/tenant-api.ts:70


getPublicTenantById

▸ getPublicTenantById(tenantId): Promise<TenantPublicDTO>

PUBLIC: Get tenant public information by ID (no auth required) NEW: For cases where you need public tenant info without API key

Parameters

NameTypeDescription
tenantIdstringThe tenant ID to retrieve public information for

Returns

Promise<TenantPublicDTO>

Defined in

tenant/api/tenant-api.ts:84


getCurrentAdmin

▸ getCurrentAdmin(): Promise<AdminDTO>

ADMIN: Get current admin info (tenant admin authentication required)

Endpoint: GET /admins/me Auth: @Admin()

Returns

Promise<AdminDTO>

Defined in

tenant/api/tenant-api.ts:99


updateRemoteTenant

▸ updateRemoteTenant(tenantData): Promise<TenantDTO>

ADMIN: Update tenant information UPDATED: Uses PUT /tenants (admin endpoint) Returns full TenantDTO including sensitive config

Parameters

NameType
tenantDataTenantUpdateRequestDTO

Returns

Promise<TenantDTO>

Defined in

tenant/api/tenant-api.ts:108


getAdmins

▸ getAdmins(options?): Promise<PaginatedResponseDTO<AdminDTO>>

ADMIN: Get all tenant admins

Parameters

NameTypeDescription
options?PaginationOptionsPagination options (page, limit, sortBy, sortOrder)

Returns

Promise<PaginatedResponseDTO<AdminDTO>>

Paginated response with tenant admins

Defined in

tenant/api/tenant-api.ts:118


postAdmin

▸ postAdmin(adminData): Promise<AdminDTO>

ADMIN: Create new admin

Parameters

NameType
adminDataAdminCreateRequestDTO

Returns

Promise<AdminDTO>

Defined in

tenant/api/tenant-api.ts:127


putAdmin

▸ putAdmin(adminId, adminData): Promise<AdminDTO>

ADMIN: Update admin (toggle tenant association)

Parameters

NameType
adminIdstring
adminDataAdminCreateRequestDTO

Returns

Promise<AdminDTO>

Defined in

tenant/api/tenant-api.ts:134