IdentityPlatformTenantOAuthIDPConfig
| Property | Value |
|---|---|
| Google Cloud Service Name | Identity Platform |
| Google Cloud Service Documentation | /identity-platform/docs/ |
| Google Cloud REST Resource Name | v2.projects.tenants.oauthIdpConfigs |
| Google Cloud REST Resource Documentation | /identity-platform/docs/reference/rest/v2/projects.tenants.oauthIdpConfigs |
| Config Connector Resource Short Names | IdentityPlatformTenantOAuthIDPConfig gcpidentityplatformtenantoauthidpconfig gcpidentityplatformtenantoauthidpconfigs identityplatformtenantoauthidpconfig |
| Config Connector Service Name | identitytoolkit.googleapis.com |
| Config Connector Resource Fully Qualified Name | identityplatformtenantoauthidpconfigs.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
clientId: string
clientSecret:
value: string
valueFrom:
secretKeyRef:
key: string
name: string
displayName: string
enabled: boolean
issuer: string
resourceID: string
responseType:
code: boolean
idToken: boolean
token: boolean
tenantRef:
external: string
name: string
namespace: string
| Fields | |
|---|---|
|
Optional |
The client id of an OAuth client. |
|
Optional |
The client secret of the OAuth client, to enable OIDC code flow. |
|
Optional |
Value of the field. Cannot be used if 'valueFrom' is specified. |
|
Optional |
Source for the field's value. Cannot be used if 'value' is specified. |
|
Optional |
Reference to a value with the given key in the given Secret in the resource's namespace. |
|
Required* |
Key that identifies the value to be extracted. |
|
Required* |
Name of the Secret to extract a value from. |
|
Optional |
The config's display name set by developers. |
|
Optional |
True if allows the user to sign in with the provider. |
|
Optional |
For OIDC Idps, the issuer identifier. |
|
Optional |
Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. |
|
Optional |
The multiple response type to request for in the OAuth authorization flow. This can possibly be a combination of set bits (e.g.: {id\_token, token}). |
|
Optional |
If true, authorization code is returned from IdP's authorization endpoint. |
|
Optional |
If true, ID token is returned from IdP's authorization endpoint. |
|
Optional |
If true, access token is returned from IdP's authorization endpoint. |
|
Required |
Immutable. |
|
Optional |
The tenant for the resource Allowed value: The Google Cloud resource name of an `IdentityPlatformTenant` resource (format: `projects/{{project}}/tenants/{{name}}`). |
|
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
* Field is required when parent field is specified
Status
Schema
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
observedGeneration: integer
| Fields | |
|---|---|
conditions |
Conditions represent the latest available observation of the resource's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
observedGeneration |
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: IdentityPlatformTenantOAuthIDPConfig
metadata:
labels:
foo: bar
name: identityplatformtenantoauthidpconfig-sample
spec:
resourceID: "oidc.tenant-oauth-idp-config-sample" # Must start with 'oidc.'
tenantRef:
name: identityplatformtenantoauthidpconfig-dep
displayName: "sample tenant oauth idp config"
clientId: "client-id"
issuer: "issuer"
enabled: true
clientSecret:
valueFrom:
secretKeyRef:
key: clientSecret
name: identityplatformtenantoauthidpconfig-dep
---
apiVersion: identityplatform.cnrm.cloud.google.com/v1beta1
kind: IdentityPlatformTenant
metadata:
name: identityplatformtenantoauthidpconfig-dep
spec:
displayName: "test-tenant"
allowPasswordSignup: true
enableAnonymousUser: false
mfaConfig:
state: "ENABLED"
testPhoneNumbers:
"+12345678901": "123451"
"+16505550000": "123450"
---
apiVersion: v1
kind: Secret
metadata:
name: identityplatformtenantoauthidpconfig-dep
stringData:
clientSecret: "secret1"