com.google.api.services.identitytoolkit.v2.model.GoogleCloudIdentitytoolkitAdminV2Tenant Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.identitytoolkit.v2.model;
/**
* A Tenant contains configuration for the tenant in a multi-tenant project.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Identity Toolkit API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class GoogleCloudIdentitytoolkitAdminV2Tenant extends com.google.api.client.json.GenericJson {
/**
* Whether to allow email/password user authentication.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean allowPasswordSignup;
/**
* Whether anonymous users will be auto-deleted after a period of 30 days.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean autodeleteAnonymousUsers;
/**
* Options related to how clients making requests on behalf of a project should be configured.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig client;
/**
* Whether authentication is disabled for the tenant. If true, the users under the disabled tenant
* are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean disableAuth;
/**
* Display name of the tenant.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String displayName;
/**
* Configuration for settings related to email privacy and public visibility.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig emailPrivacyConfig;
/**
* Whether to enable anonymous user authentication.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableAnonymousUser;
/**
* Whether to enable email link user authentication.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean enableEmailLinkSignin;
/**
* Output only. Hash config information of a tenant for display on Pantheon. This can only be
* displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only
* returned in GetTenant response to restrict reading of this information. Requires
* firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2HashConfig hashConfig;
/**
* Specify the settings that the tenant could inherit.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2Inheritance inheritance;
/**
* The tenant-level configuration of MFA options.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig mfaConfig;
/**
* Configuration related to monitoring project activity.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2MonitoringConfig monitoring;
/**
* Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-
* id}"
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* The tenant-level password policy config
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2PasswordPolicyConfig passwordPolicyConfig;
/**
* The tenant-level reCAPTCHA config.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig recaptchaConfig;
/**
* Configures which regions are enabled for SMS verification code sending.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig smsRegionConfig;
/**
* A map of pairs that can be used for MFA. The phone number should be in E.164 format
* (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be
* thrown once exceeded).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map testPhoneNumbers;
/**
* Whether to allow email/password user authentication.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAllowPasswordSignup() {
return allowPasswordSignup;
}
/**
* Whether to allow email/password user authentication.
* @param allowPasswordSignup allowPasswordSignup or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setAllowPasswordSignup(java.lang.Boolean allowPasswordSignup) {
this.allowPasswordSignup = allowPasswordSignup;
return this;
}
/**
* Whether anonymous users will be auto-deleted after a period of 30 days.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAutodeleteAnonymousUsers() {
return autodeleteAnonymousUsers;
}
/**
* Whether anonymous users will be auto-deleted after a period of 30 days.
* @param autodeleteAnonymousUsers autodeleteAnonymousUsers or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setAutodeleteAnonymousUsers(java.lang.Boolean autodeleteAnonymousUsers) {
this.autodeleteAnonymousUsers = autodeleteAnonymousUsers;
return this;
}
/**
* Options related to how clients making requests on behalf of a project should be configured.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig getClient() {
return client;
}
/**
* Options related to how clients making requests on behalf of a project should be configured.
* @param client client or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setClient(GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig client) {
this.client = client;
return this;
}
/**
* Whether authentication is disabled for the tenant. If true, the users under the disabled tenant
* are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
* @return value or {@code null} for none
*/
public java.lang.Boolean getDisableAuth() {
return disableAuth;
}
/**
* Whether authentication is disabled for the tenant. If true, the users under the disabled tenant
* are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.
* @param disableAuth disableAuth or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setDisableAuth(java.lang.Boolean disableAuth) {
this.disableAuth = disableAuth;
return this;
}
/**
* Display name of the tenant.
* @return value or {@code null} for none
*/
public java.lang.String getDisplayName() {
return displayName;
}
/**
* Display name of the tenant.
* @param displayName displayName or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setDisplayName(java.lang.String displayName) {
this.displayName = displayName;
return this;
}
/**
* Configuration for settings related to email privacy and public visibility.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig getEmailPrivacyConfig() {
return emailPrivacyConfig;
}
/**
* Configuration for settings related to email privacy and public visibility.
* @param emailPrivacyConfig emailPrivacyConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setEmailPrivacyConfig(GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig emailPrivacyConfig) {
this.emailPrivacyConfig = emailPrivacyConfig;
return this;
}
/**
* Whether to enable anonymous user authentication.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableAnonymousUser() {
return enableAnonymousUser;
}
/**
* Whether to enable anonymous user authentication.
* @param enableAnonymousUser enableAnonymousUser or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setEnableAnonymousUser(java.lang.Boolean enableAnonymousUser) {
this.enableAnonymousUser = enableAnonymousUser;
return this;
}
/**
* Whether to enable email link user authentication.
* @return value or {@code null} for none
*/
public java.lang.Boolean getEnableEmailLinkSignin() {
return enableEmailLinkSignin;
}
/**
* Whether to enable email link user authentication.
* @param enableEmailLinkSignin enableEmailLinkSignin or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setEnableEmailLinkSignin(java.lang.Boolean enableEmailLinkSignin) {
this.enableEmailLinkSignin = enableEmailLinkSignin;
return this;
}
/**
* Output only. Hash config information of a tenant for display on Pantheon. This can only be
* displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only
* returned in GetTenant response to restrict reading of this information. Requires
* firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2HashConfig getHashConfig() {
return hashConfig;
}
/**
* Output only. Hash config information of a tenant for display on Pantheon. This can only be
* displayed on Pantheon to avoid the sensitive information to get accidentally leaked. Only
* returned in GetTenant response to restrict reading of this information. Requires
* firebaseauth.configs.getHashConfig permission on the agent project for returning this field.
* @param hashConfig hashConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setHashConfig(GoogleCloudIdentitytoolkitAdminV2HashConfig hashConfig) {
this.hashConfig = hashConfig;
return this;
}
/**
* Specify the settings that the tenant could inherit.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Inheritance getInheritance() {
return inheritance;
}
/**
* Specify the settings that the tenant could inherit.
* @param inheritance inheritance or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setInheritance(GoogleCloudIdentitytoolkitAdminV2Inheritance inheritance) {
this.inheritance = inheritance;
return this;
}
/**
* The tenant-level configuration of MFA options.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig getMfaConfig() {
return mfaConfig;
}
/**
* The tenant-level configuration of MFA options.
* @param mfaConfig mfaConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setMfaConfig(GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig mfaConfig) {
this.mfaConfig = mfaConfig;
return this;
}
/**
* Configuration related to monitoring project activity.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2MonitoringConfig getMonitoring() {
return monitoring;
}
/**
* Configuration related to monitoring project activity.
* @param monitoring monitoring or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setMonitoring(GoogleCloudIdentitytoolkitAdminV2MonitoringConfig monitoring) {
this.monitoring = monitoring;
return this;
}
/**
* Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-
* id}"
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-
* id}"
* @param name name or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* The tenant-level password policy config
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2PasswordPolicyConfig getPasswordPolicyConfig() {
return passwordPolicyConfig;
}
/**
* The tenant-level password policy config
* @param passwordPolicyConfig passwordPolicyConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setPasswordPolicyConfig(GoogleCloudIdentitytoolkitAdminV2PasswordPolicyConfig passwordPolicyConfig) {
this.passwordPolicyConfig = passwordPolicyConfig;
return this;
}
/**
* The tenant-level reCAPTCHA config.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig getRecaptchaConfig() {
return recaptchaConfig;
}
/**
* The tenant-level reCAPTCHA config.
* @param recaptchaConfig recaptchaConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setRecaptchaConfig(GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig recaptchaConfig) {
this.recaptchaConfig = recaptchaConfig;
return this;
}
/**
* Configures which regions are enabled for SMS verification code sending.
* @return value or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig getSmsRegionConfig() {
return smsRegionConfig;
}
/**
* Configures which regions are enabled for SMS verification code sending.
* @param smsRegionConfig smsRegionConfig or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setSmsRegionConfig(GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig smsRegionConfig) {
this.smsRegionConfig = smsRegionConfig;
return this;
}
/**
* A map of pairs that can be used for MFA. The phone number should be in E.164 format
* (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be
* thrown once exceeded).
* @return value or {@code null} for none
*/
public java.util.Map getTestPhoneNumbers() {
return testPhoneNumbers;
}
/**
* A map of pairs that can be used for MFA. The phone number should be in E.164 format
* (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be
* thrown once exceeded).
* @param testPhoneNumbers testPhoneNumbers or {@code null} for none
*/
public GoogleCloudIdentitytoolkitAdminV2Tenant setTestPhoneNumbers(java.util.Map testPhoneNumbers) {
this.testPhoneNumbers = testPhoneNumbers;
return this;
}
@Override
public GoogleCloudIdentitytoolkitAdminV2Tenant set(String fieldName, Object value) {
return (GoogleCloudIdentitytoolkitAdminV2Tenant) super.set(fieldName, value);
}
@Override
public GoogleCloudIdentitytoolkitAdminV2Tenant clone() {
return (GoogleCloudIdentitytoolkitAdminV2Tenant) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy