테넌트 관련 작업을 관리하는 데 사용되는 테넌트 관리자를 정의합니다. 여기에는 다음이 포함됩니다.
- 기본 프로젝트의 테넌트를 생성, 업데이트, 나열, 가져오기, 삭제할 수 있는 기능.
- 지정된 테넌트의 컨텍스트에서 인증 관련 작업 (사용자 관리, 제공업체 구성 관리, 토큰 확인, 이메일 링크 생성 등)을 실행하기 위한
TenantAwareAuth인스턴스 가져오기
서명:
export declare class TenantManager
메소드
| 메서드 | 특수키 | 설명 |
|---|---|---|
| authForTenant(테넌트 ID) | 지정된 테넌트 ID에 바인딩된 TenantAwareAuth 인스턴스를 반환합니다. |
|
| createTenant(테넌트 옵션) | 새 테넌트를 만듭니다. 새 테넌트를 만들 때 별도의 결제 및 할당량을 사용하는 테넌트에는 자체 프로젝트가 필요하며 full_service로 정의해야 합니다. |
|
| deleteTenant(테넌트 ID) | 기존 테넌트를 삭제합니다. | |
| getTenant(테넌트 ID) | 지정된 tenantId에 해당하는 테넌트의 테넌트 구성을 가져옵니다. |
|
| listTenants(maxResults, pageToken) | pageToken로 지정된 오프셋에서 시작하여 크기가 maxResults인 테넌트 목록 (단일 배치만)을 검색합니다. 지정된 프로젝트의 모든 테넌트를 일괄적으로 검색하는 데 사용됩니다. |
|
| updateTenant(테넌트 ID, 테넌트 옵션) | 기존 테넌트 구성을 업데이트합니다. |
TenantManager.authForTenant()
지정된 테넌트 ID에 바인딩된 TenantAwareAuth 인스턴스를 반환합니다.
서명:
authForTenant(tenantId: string): TenantAwareAuth;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| tenantId | 문자열 | TenantAwareAuth 인스턴스가 반환될 테넌트 ID입니다. |
반환:
이 테넌트 식별자에 해당하는 TenantAwareAuth 인스턴스입니다.
TenantManager.createTenant()
새 테넌트를 만듭니다. 새 테넌트를 만들 때 별도의 결제 및 할당량을 사용하는 테넌트에는 자체 프로젝트가 필요하며 full_service로 정의해야 합니다.
서명:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| 테넌트 옵션 | CreateTenantRequest | 만들 새 테넌트 구성에 설정할 속성입니다. |
반환:
프로미스<테넌트>
새로 만든 테넌트에 해당하는 테넌트 구성으로 프로미스가 처리됩니다.
TenantManager.deleteTenant()
기존 테넌트를 삭제합니다.
서명:
deleteTenant(tenantId: string): Promise<void>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| tenantId | 문자열 | 삭제할 테넌트에 해당하는 tenantId입니다. |
반환:
프로미스<void>
테넌트가 삭제되면 빈 프로미스가 처리됩니다.
TenantManager.getTenant()
지정된 tenantId에 해당하는 테넌트의 테넌트 구성을 가져옵니다.
서명:
getTenant(tenantId: string): Promise<Tenant>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| tenantId | 문자열 | 데이터를 가져올 테넌트에 해당하는 테넌트 식별자입니다. |
반환:
프로미스<테넌트>
제공된 tenantId에 대한 테넌트 구성으로 프로미스가 처리되었습니다.
TenantManager.listTenants()
pageToken로 지정된 오프셋에서 시작하여 크기가 maxResults인 테넌트 목록 (단일 배치만)을 검색합니다. 지정된 프로젝트의 모든 테넌트를 일괄적으로 검색하는 데 사용됩니다.
서명:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| maxResults | 숫자 | 페이지 크기(정의되지 않은 경우 1000) 이 한도는 허용되는 최대 한도이기도 합니다. |
| pageToken | 문자열 | 다음 페이지 토큰입니다. 지정하지 않으면 오프셋 없이 시작되는 테넌트가 반환됩니다. |
반환:
프로미스 <ListTenantsResult>
다운로드된 테넌트 일괄과 다음 페이지 토큰으로 확인되는 프로미스입니다.
TenantManager.updateTenant()
기존 테넌트 구성을 업데이트합니다.
서명:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
매개변수
| 매개변수 | 유형 | 설명 |
|---|---|---|
| tenantId | 문자열 | 삭제할 테넌트에 해당하는 tenantId입니다. |
| 테넌트 옵션 | UpdateTenantRequest에 대한 요청 메시지입니다. | 제공된 테넌트에서 업데이트할 속성입니다. |
반환:
프로미스<테넌트>
테넌트 데이터 업데이트로 처리된 프로미스입니다.