TenantManager class

테넌트 관련 작업을 관리하는 데 사용되는 테넌트 관리자를 정의합니다. 여기에는 다음이 포함됩니다.

  • 기본 프로젝트에 대한 테넌트를 생성, 업데이트, 나열, 가져오기 및 삭제하는 기능입니다.
  • 지정된 테넌트의 컨텍스트에서 인증 관련 작업(사용자 관리, 공급자 구성 관리, 토큰 확인, 이메일 링크 생성 등)을 실행하기 위한 TenantAwareAuth 인스턴스를 가져옵니다.

서명:

export declare class TenantManager 

행동 양식

방법 수정자 설명
authForTenant(테넌트 ID) 지정된 테넌트 ID에 바인딩된 TenantAwareAuth 인스턴스를 반환합니다.
createTenant(테넌트옵션) 새 테넌트를 만듭니다. 새 테넌트를 생성할 때 별도의 청구 및 할당량을 사용하는 테넌트는 자체 프로젝트가 필요하며 full_service 로 정의되어야 합니다.
deleteTenant(테넌트 ID) 기존 테넌트를 삭제합니다.
getTenant(테넌트 ID) 지정된 tenantId 에 해당하는 테넌트에 대한 테넌트 구성을 가져옵니다.
listTenants(maxResults, pageToken) pageToken 에 지정된 오프셋에서 시작하여 maxResults 크기의 테넌트 목록(단일 배치만 해당)을 검색합니다. 지정된 프로젝트의 모든 테넌트를 일괄적으로 검색하는 데 사용됩니다.
updateTenant(tenantId, 테넌트옵션) 기존 테넌트 구성을 업데이트합니다.

TenantManager.authForTenant()

지정된 테넌트 ID에 바인딩된 TenantAwareAuth 인스턴스를 반환합니다.

서명:

authForTenant(tenantId: string): TenantAwareAuth;

매개변수

매개변수 유형 설명
테넌트 ID TenantAwareAuth 인스턴스가 반환될 테넌트 ID입니다.

보고:

테넌트 인식 인증

이 테넌트 식별자에 해당하는 TenantAwareAuth 인스턴스입니다.

TenantManager.createTenant()

새 테넌트를 만듭니다. 새 테넌트를 생성할 때 별도의 청구 및 할당량을 사용하는 테넌트는 자체 프로젝트가 필요하며 full_service 로 정의되어야 합니다. .

서명:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

매개변수

매개변수 유형 설명
테넌트 옵션 테넌트 요청 생성 생성할 새 테넌트 구성에 설정할 속성입니다.

보고:

약속< 임차인 >

새로 생성된 테넌트에 해당하는 테넌트 구성으로 이행되는 약속입니다.

TenantManager.delete테넌트()

기존 테넌트를 삭제합니다.

서명:

deleteTenant(tenantId: string): Promise<void>;

매개변수

매개변수 유형 설명
테넌트 ID 삭제할 테넌트에 해당하는 tenantId 입니다.

보고:

약속<공허>

테넌트가 삭제되면 빈 약속이 이행됩니다.

TenantManager.getTenant()

지정된 tenantId 에 해당하는 테넌트에 대한 테넌트 구성을 가져옵니다. .

서명:

getTenant(tenantId: string): Promise<Tenant>;

매개변수

매개변수 유형 설명
테넌트 ID 데이터를 가져올 테넌트에 해당하는 테넌트 식별자입니다.

보고:

약속< 임차인 >

제공된 tenantId 에 대한 테넌트 구성으로 이행된 약속 .

TenantManager.list테넌트()

pageToken 에 지정된 오프셋에서 시작하여 maxResults 크기의 테넌트 목록(단일 배치만 해당)을 검색합니다. . 지정된 프로젝트의 모든 테넌트를 일괄적으로 검색하는 데 사용됩니다.

서명:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

매개변수

매개변수 유형 설명
최대 결과 숫자 페이지 크기는 정의되지 않은 경우 1000입니다. 이는 최대 허용 한도이기도 합니다.
페이지토큰 다음 페이지 토큰입니다. 지정하지 않으면 오프셋 없이 시작하는 테넌트를 반환합니다.

보고:

약속< ListTenantsResult >

다운로드한 테넌트 배치와 다음 페이지 토큰으로 해결되는 약속입니다.

TenantManager.update테넌트()

기존 테넌트 구성을 업데이트합니다.

서명:

updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;

매개변수

매개변수 유형 설명
테넌트 ID 삭제할 테넌트에 해당하는 tenantId 입니다.
테넌트 옵션 업데이트테넌트요청 제공된 테넌트에서 업데이트할 속성입니다.

보고:

약속< 임차인 >

업데이트 테넌트 데이터로 이행된 약속입니다.