Tenant class

Rappresenta una configurazione tenant.

Il supporto multi-tenancy richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Prima di poter utilizzare la multi-tenancy su un progetto Google Cloud Identity Platform, è necessario consentire l'utilizzo dei tenant su tale progetto tramite l'interfaccia utente di Cloud Console.

Una configurazione del tenant fornisce informazioni quali il nome visualizzato, l'identificatore del tenant e la configurazione dell'autenticazione della posta elettronica. Per la gestione della configurazione del provider OIDC/SAML, è necessario utilizzare le istanze TenantAwareAuth anziché un Tenant per recuperare l'elenco degli IdP configurati su un tenant. Quando si configurano questi provider, tenere presente che i tenant erediteranno i domini autorizzati e gli URI di reindirizzamento autenticati del progetto principale.

Verranno ereditate anche tutte le altre impostazioni di un tenant. Questi dovranno essere gestiti dall'interfaccia utente di Cloud Console.

Firma:

export declare class Tenant 

Proprietà

Proprietà Modificatori Tipo Descrizione
anonimoSignInEnabled booleano
nome da visualizzare corda Il nome visualizzato del tenant.
emailPrivacyConfig EmailPrivacyConfig La configurazione della privacy della posta elettronica per il tenant
emailSignInConfig EmailSignInProviderConfig | non definito L'e-mail accede alla configurazione del provider.
multiFactorConfig MultiFactorConfig | non definito La configurazione dell'autenticazione a più fattori nel tenant corrente.
passwordPolicyConfig PasswordPolicyConfig La configurazione dei criteri password per il tenant
recaptchaConfig RecaptchaConfig | non definito La configurazione di autenticazione recaptcha config del tenant corrente.
smsRegionConfig SmsRegionConfig La configurazione delle regioni SMS per aggiornare un tenant. Configura le regioni in cui gli utenti possono inviare SMS di verifica. Questo si basa sul codice chiamante del numero di telefono di destinazione.
inquilinoId corda L'identificatore dell'inquilino.
testNumeri di telefono { [numerotelefono: stringa]: stringa; } La mappa contenente le coppie di numeri di telefono/codici di prova per l'inquilino.

Metodi

Metodo Modificatori Descrizione
aJSON() Restituisce una rappresentazione serializzabile JSON di questo oggetto.

Tenant.anonymousSignInEnabled

Firma:

readonly anonymousSignInEnabled: boolean;

Tenant.displayName

Il nome visualizzato del tenant.

Firma:

readonly displayName?: string;

Tenant.emailPrivacyConfig

La configurazione della privacy della posta elettronica per il tenant

Firma:

readonly emailPrivacyConfig?: EmailPrivacyConfig;

Tenant.emailSignInConfig

L'e-mail accede alla configurazione del provider.

Firma:

get emailSignInConfig(): EmailSignInProviderConfig | undefined;

Tenant.multiFactorConfig

La configurazione dell'autenticazione a più fattori nel tenant corrente.

Firma:

get multiFactorConfig(): MultiFactorConfig | undefined;

Tenant.passwordPolicyConfig

La configurazione dei criteri password per il tenant

Firma:

readonly passwordPolicyConfig?: PasswordPolicyConfig;

Tenant.recaptchaConfig

La configurazione di autenticazione recaptcha config del tenant corrente.

Firma:

get recaptchaConfig(): RecaptchaConfig | undefined;

Tenant.smsRegionConfig

La configurazione delle regioni SMS per aggiornare un tenant. Configura le regioni in cui gli utenti possono inviare SMS di verifica. Questo si basa sul codice chiamante del numero di telefono di destinazione.

Firma:

readonly smsRegionConfig?: SmsRegionConfig;

Tenant.tenantId

L'identificatore dell'inquilino.

Firma:

readonly tenantId: string;

Tenant.testPhoneNumbers

La mappa contenente le coppie di numeri di telefono/codici di prova per l'inquilino.

Firma:

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

Tenant.toJSON()

Restituisce una rappresentazione serializzabile JSON di questo oggetto.

Firma:

toJSON(): object;

Ritorna:

oggetto

Una rappresentazione serializzabile JSON di questo oggetto.