Tenant class

Create a tenant. Requires write permission on the Agent project. Auto-naming is currently not supported for this resource.

Constructors

Tenant(String name, {TenantArgs? args, CustomResourceOptions? options})
Creates a new Tenant. name The Pulumi resource name. args Arguments used to configure this Tenant. The set of arguments for Tenant. options Resource options controlling this resource's behavior.

Properties

allowPasswordSignup ↔ Output<bool>
Whether to allow email/password user authentication.
latefinal
autodeleteAnonymousUsers ↔ Output<bool>
Whether anonymous users will be auto-deleted after a period of 30 days.
latefinal
childResources → Set<Resource>
finalinherited
client ↔ Output<GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfigResponse>
Options related to how clients making requests on behalf of a project should be configured.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
disableAuth ↔ Output<bool>
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.
latefinal
displayName ↔ Output<String>
Display name of the tenant.
latefinal
emailPrivacyConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfigResponse>
Configuration for settings related to email privacy and public visibility.
latefinal
enableAnonymousUser ↔ Output<bool>
Whether to enable anonymous user authentication.
latefinal
enableEmailLinkSignin ↔ Output<bool>
Whether to enable email link user authentication.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
hashConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2HashConfigResponse>
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.
latefinal
id ↔ Output<String>
getter/setter pairinherited
inheritance ↔ Output<GoogleCloudIdentitytoolkitAdminV2InheritanceResponse>
Specify the settings that the tenant could inherit.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
mfaConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfigResponse>
The tenant-level configuration of MFA options.
latefinal
monitoring ↔ Output<GoogleCloudIdentitytoolkitAdminV2MonitoringConfigResponse>
Configuration related to monitoring project activity.
latefinal
name ↔ Output<String>
Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}"
latefinal
passwordPolicyConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2PasswordPolicyConfigResponse>
The tenant-level password policy config
latefinal
project ↔ Output<String>
latefinal
recaptchaConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2RecaptchaConfigResponse>
The tenant-level reCAPTCHA config.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
smsRegionConfig ↔ Output<GoogleCloudIdentitytoolkitAdminV2SmsRegionConfigResponse>
Configures which regions are enabled for SMS verification code sending.
latefinal
testPhoneNumbers ↔ Output<Map<String, String>>
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).
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited