IdentityPlatformOAuthIDPConfig

---

Note: You must enable the Google Identity Platform in the marketplace prior to using this resource.

Note: You must specify the resource's name in metadata.name or spec.resourceID starting with "oidc.".

Property	Value
Google Cloud Service Name	Identity Platform
Google Cloud Service Documentation	/identity-platform/docs/
Google Cloud REST Resource Name	v2.projects.oauthIdpConfigs
Google Cloud REST Resource Documentation	/identity-platform/docs/reference/rest/v2/projects.oauthIdpConfigs
Config Connector Resource Short Names	IdentityPlatformOAuthIDPConfig gcpidentityplatformoauthidpconfig gcpidentityplatformoauthidpconfigs identityplatformoauthidpconfig
Config Connector Service Name	identitytoolkit.googleapis.com
Config Connector Resource Fully Qualified Name	identityplatformoauthidpconfigs.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

Fields
clientId Optional	string The client id of an OAuth client.
clientSecret Optional	object The client secret of the OAuth client, to enable OIDC code flow.
clientSecret.value Optional	string Value of the field. Cannot be used if 'valueFrom' is specified.
clientSecret.valueFrom Optional	object Source for the field's value. Cannot be used if 'value' is specified.
clientSecret.valueFrom.secretKeyRef Optional	object Reference to a value with the given key in the given Secret in the resource's namespace.
clientSecret.valueFrom.secretKeyRef.key Required*	string Key that identifies the value to be extracted.
clientSecret.valueFrom.secretKeyRef.name Required*	string Name of the Secret to extract a value from.
displayName Optional	string The config's display name set by developers.
enabled Optional	boolean True if allows the user to sign in with the provider.
issuer Optional	string For OIDC Idps, the issuer identifier.
resourceID Optional	string Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.
responseType Optional	object 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}).
responseType.code Optional	boolean If true, authorization code is returned from IdP's authorization endpoint.
responseType.idToken Optional	boolean If true, ID token is returned from IdP's authorization endpoint.
responseType.token Optional	boolean If true, access token is returned from IdP's authorization endpoint.

* 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	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: IdentityPlatformOAuthIDPConfig
metadata:
  name: identityplatformoauthidpconfig-sample
spec:
  resourceID: "oidc.project-oauth-idp-config-sample" # Must start with 'oidc.'
  displayName: "sample oauth idp config"
  clientId: "client-id"
  issuer: "issuer"
  enabled: true
  clientSecret:
    valueFrom:
      secretKeyRef:
        key: clientSecret
        name: identityplatformoauthidpconfig-dep
---
apiVersion: v1
kind: Secret
metadata:
  name: identityplatformoauthidpconfig-dep
stringData:
  clientSecret: "secret"

Note: If you have any trouble with instantiating the resource, refer to Troubleshoot Config Connector.