Tenant class

테넌트 구성을 나타냅니다.

멀티테넌시 지원을 사용하려면 Google Cloud의 Identity Platform (GCIP)이 필요합니다. 가격 책정 및 기능을 포함하여 GCIP에 대해 자세히 알아보려면 GCIP 문서를 참조하세요.

Google Cloud Identity Platform 프로젝트에서 멀티테넌시를 사용하려면 먼저 Cloud 콘솔 UI를 통해 해당 프로젝트에서 테넌트를 허용해야 합니다.

테넌트 구성은 표시 이름, 테넌트 식별자, 이메일 인증 구성과 같은 정보를 제공합니다. OIDC/SAML 제공업체 구성 관리의 경우 테넌트에 구성된 IdP 목록을 검색하려면 Tenant 대신 TenantAwareAuth 인스턴스를 사용해야 합니다. 이러한 제공업체를 구성할 때 테넌트는 상위 프로젝트의 허용된 도메인 및 인증된 리디렉션 URI를 상속합니다.

테넌트의 다른 모든 설정도 상속됩니다. 이는 Cloud 콘솔 UI에서 관리해야 합니다.

서명:

export declare class Tenant 

속성

속성 특수키 유형 설명
anonymousSignInEnabled 부울
표시 이름 문자열 테넌트 표시 이름입니다.
emailPrivacyConfig EmailPrivacyConfig 테넌트의 이메일 개인 정보 보호 구성
emailSignInConfig EmailSignInProviderConfig | 정의되지 않음 이메일 로그인 공급업체 구성
multiFactorConfig MultiFactorConfig | 정의되지 않음 현재 테넌트의 다중 인증 구성입니다.
passwordPolicyConfig PasswordPolicyConfig 테넌트의 비밀번호 정책 구성
recaptchaConfig RecaptchaConfig | 정의되지 않음 현재 테넌트의 reCAPTCHA 구성 인증 구성입니다.
smsRegionConfig SmsRegionConfig 테넌트를 업데이트할 SMS 리전 구성입니다. 사용자가 인증 SMS를 보낼 수 있는 리전을 구성합니다. 이는 대상 전화번호의 통화 코드를 기반으로 합니다.
테넌트 ID 문자열 테넌트 식별자입니다.
testPhoneNumbers { [phoneNumber: string]: string; } 테넌트의 테스트 전화번호 / 코드 쌍이 포함된 맵입니다.

메소드

메서드 특수키 설명
JSON()으로 전송합니다. 이 객체의 JSON 직렬화 가능한 표현을 반환합니다.

Tenant.anonymousSignInEnabled

서명:

readonly anonymousSignInEnabled: boolean;

Tenant.displayName

테넌트 표시 이름입니다.

서명:

readonly displayName?: string;

Tenant.emailPrivacyConfig

테넌트의 이메일 개인 정보 보호 구성

서명:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

Tenant.emailSignInConfig

이메일 로그인 공급업체 구성

서명:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

Tenant.multiFactorConfig

현재 테넌트의 다중 인증 구성입니다.

서명:

get multiFactorConfig(): MultiFactorConfig | undefined;

Tenant.passwordPolicyConfig

테넌트의 비밀번호 정책 구성

서명:

readonly passwordPolicyConfig?: PasswordPolicyConfig;

Tenant.recaptchaConfig

현재 테넌트의 reCAPTCHA 구성 인증 구성입니다.

서명:

get recaptchaConfig(): RecaptchaConfig | undefined;

Tenant.smsRegionConfig

테넌트를 업데이트할 SMS 리전 구성입니다. 사용자가 인증 SMS를 보낼 수 있는 리전을 구성합니다. 이는 대상 전화번호의 통화 코드를 기반으로 합니다.

서명:

readonly smsRegionConfig?: SmsRegionConfig;

테넌트.테넌트 ID

테넌트 식별자입니다.

서명:

readonly tenantId: string;

Tenant.testPhoneNumbers

테넌트의 테스트 전화번호 / 코드 쌍이 포함된 맵입니다.

서명:

readonly testPhoneNumbers?: {
        [phoneNumber: string]: string;
    };

Tenant.toJSON()

이 객체의 JSON 직렬화 가능한 표현을 반환합니다.

서명:

toJSON(): object;

반환:

객체

JSON 직렬화 가능한 이 객체의 표현입니다.