IdentityPlatformTenant

Property	Value
Google Cloud Service Name	Identity Platform
Google Cloud Service Documentation	/identity-platform/docs/
Google Cloud REST Resource Name	v2.projects.tenants
Google Cloud REST Resource Documentation	/identity-platform/docs/reference/rest/v2/projects.tenants
Config Connector Resource Short Names	IdentityPlatformTenant gcpidentityplatformtenant gcpidentityplatformtenants identityplatformtenant
Config Connector Service Name	identitytoolkit.googleapis.com
Config Connector Resource Fully Qualified Name	identityplatformtenants.identityplatform.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Annotations

Fields
`cnrm.cloud.google.com/project-id`

Spec

Schema

allowPasswordSignup: boolean
disableAuth: boolean
displayName: string
enableAnonymousUser: boolean
enableEmailLinkSignin: boolean
mfaConfig:
  enabledProviders:
  - string
  state: string
resourceID: string
testPhoneNumbers:
  string: string

Fields

Fields
`allowPasswordSignup` Optional	`boolean` Whether to allow email/password user authentication.
`disableAuth` Optional	`boolean` 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.
`displayName` Optional	`string` Display name of the tenant.
`enableAnonymousUser` Optional	`boolean` Whether to enable anonymous user authentication.
`enableEmailLinkSignin` Optional	`boolean` Whether to enable email link user authentication.
`mfaConfig` Optional	`object` The tenant-level configuration of MFA options.
`mfaConfig.enabledProviders` Optional	`list (string)` A list of usable second factors for this project.
`mfaConfig.enabledProviders[]` Optional	`string`
`mfaConfig.state` Optional	`string` Whether MultiFactor Authentication has been enabled for this project. Possible values: STATE_UNSPECIFIED, DISABLED, ENABLED, MANDATORY
`resourceID` Optional	`string` Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.
`testPhoneNumbers` Optional	`map (key: string, value: 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).

allowPasswordSignup

Optional

boolean

Whether to allow email/password user authentication.

disableAuth

Optional

boolean

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.

displayName

Optional

string

Display name of the tenant.

enableAnonymousUser

Optional

boolean

Whether to enable anonymous user authentication.

enableEmailLinkSignin

Optional

boolean

Whether to enable email link user authentication.

mfaConfig

Optional

object

The tenant-level configuration of MFA options.

mfaConfig.enabledProviders

Optional

list (string)

A list of usable second factors for this project.

mfaConfig.enabledProviders[]

Optional

string

mfaConfig.state

Optional

string

Whether MultiFactor Authentication has been enabled for this project. Possible values: STATE_UNSPECIFIED, DISABLED, ENABLED, MANDATORY

resourceID

Optional

string

Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.

testPhoneNumbers

Optional

map (key: string, value: 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).

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
observedGeneration: integer

Fields
`conditions`	`list (object)` Conditions represent the latest available observation of the resource's current state.
`conditions[]`	`object`
`conditions[].lastTransitionTime`	`string` Last time the condition transitioned from one status to another.
`conditions[].message`	`string` Human-readable message indicating details about last transition.
`conditions[].reason`	`string` Unique, one-word, CamelCase reason for the condition's last transition.
`conditions[].status`	`string` Status is the status of the condition. Can be True, False, Unknown.
`conditions[].type`	`string` Type is the type of the condition.
`observedGeneration`	`integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

Sample YAML(s)

Typical Use Case

# Copyright 2020 Google LLC
#
# 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.

apiVersion: identityplatform.cnrm.cloud.google.com/v1beta1
kind: IdentityPlatformTenant
metadata:
  name: identityplatformtenant-sample
spec:
  displayName: "sample-tenant"
  allowPasswordSignup: true
  enableAnonymousUser: false
  mfaConfig:
    state: "ENABLED"
  testPhoneNumbers:
    "+12345678901": "123451"
    "+16505550000": "123450"