Représente une configuration de locataire.
La prise en charge de l'architecture mutualisée nécessite la plate-forme d'identité de Google Cloud (GCIP). Pour en savoir plus sur GCIP, y compris les tarifs et les fonctionnalités, consultez la documentation GCIP. .
Avant que la multilocation puisse être utilisée sur un projet Google Cloud Identity Platform, les locataires doivent être autorisés sur ce projet via l'interface utilisateur de Cloud Console.
Une configuration de locataire fournit des informations telles que le nom d'affichage, l'identifiant du locataire et la configuration de l'authentification par courrier électronique. Pour la gestion de la configuration du fournisseur OIDC/SAML, les instances TenantAwareAuth doivent être utilisées à la place d'un Tenant pour récupérer la liste des IdP configurés sur un locataire. Lors de la configuration de ces fournisseurs, notez que les locataires hériteront des domaines sur liste blanche et des URI de redirection authentifiés de leur projet parent.
Tous les autres paramètres d'un locataire seront également hérités. Ceux-ci devront être gérés à partir de l’interface utilisateur de Cloud Console.
Signature:
export declare class Tenant
Propriétés
| Propriété | Modificateurs | Taper | Description |
|---|---|---|---|
| anonymeConnexionEnabled | booléen | ||
| Afficher un nom | chaîne | Nom d’affichage du locataire. | |
| emailPrivacyConfig | EmailConfidentialitéConfig | La configuration de la confidentialité des e-mails pour le locataire | |
| emailSignInConfig | EmailSignInProviderConfig | indéfini | La configuration du fournisseur de connexion par e-mail. | |
| multiFactorConfig | Configuration multifacteur | indéfini | La configuration de l'authentification multifacteur sur le locataire actuel. | |
| mot de passePolicyConfig | Configuration de la politique de mot de passe | La configuration de la politique de mot de passe pour le locataire | |
| recaptchaConfig | RécaptchaConfig | indéfini | La configuration d'authentification recaptcha config du locataire actuel. | |
| smsRegionConfig | SmsRegionConfig | Configuration des régions SMS pour mettre à jour un locataire. Configure les régions dans lesquelles les utilisateurs sont autorisés à envoyer des SMS de vérification. Ceci est basé sur l’indicatif d’appel du numéro de téléphone de destination. | |
| ID locataire | chaîne | L’identifiant du locataire. | |
| tester les numéros de téléphone | { [numéro de téléphone : chaîne] : chaîne ; } | Le plan contenant les couples numéro de téléphone/code test du locataire. |
Méthodes
| Méthode | Modificateurs | Description |
|---|---|---|
| versJSON() | Renvoie une représentation sérialisable JSON de cet objet. |
Tenant.anonymousSignInEnabled
Signature:
readonly anonymousSignInEnabled: boolean;
Locataire.displayName
Nom d’affichage du locataire.
Signature:
readonly displayName?: string;
Tenant.emailPrivacyConfig
La configuration de la confidentialité des e-mails pour le locataire
Signature:
readonly emailPrivacyConfig?: EmailPrivacyConfig;
Tenant.emailSignInConfig
La configuration du fournisseur de connexion par e-mail.
Signature:
get emailSignInConfig(): EmailSignInProviderConfig | undefined;
Tenant.multiFactorConfig
La configuration de l'authentification multifacteur sur le locataire actuel.
Signature:
get multiFactorConfig(): MultiFactorConfig | undefined;
Tenant.passwordPolicyConfig
La configuration de la politique de mot de passe pour le locataire
Signature:
readonly passwordPolicyConfig?: PasswordPolicyConfig;
Locataire.recaptchaConfig
La configuration d'authentification recaptcha config du locataire actuel.
Signature:
get recaptchaConfig(): RecaptchaConfig | undefined;
Tenant.smsRegionConfig
Configuration des régions SMS pour mettre à jour un locataire. Configure les régions dans lesquelles les utilisateurs sont autorisés à envoyer des SMS de vérification. Ceci est basé sur l’indicatif d’appel du numéro de téléphone de destination.
Signature:
readonly smsRegionConfig?: SmsRegionConfig;
Locataire.tenantId
L’identifiant du locataire.
Signature:
readonly tenantId: string;
Tenant.testPhoneNumbers
Le plan contenant les couples numéro de téléphone/code test du locataire.
Signature:
readonly testPhoneNumbers?: {
[phoneNumber: string]: string;
};
Locataire.toJSON()
Renvoie une représentation sérialisable JSON de cet objet.
Signature:
toJSON(): object;
Retour:
objet
Une représentation sérialisable JSON de cet objet.