IAMWorkloadIdentityPoolProvider

Property Value
Google Cloud Service Name IAM
Google Cloud Service Documentation /iam/docs/
Google Cloud REST Resource Name v1.projects.locations.workloadIdentityPools.providers
Google Cloud REST Resource Documentation /iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers
Config Connector Resource Short Names gcpiamworkloadidentitypoolprovider
gcpiamworkloadidentitypoolproviders
iamworkloadidentitypoolprovider
Config Connector Service Name iam.googleapis.com
Config Connector Resource Fully Qualified Name iamworkloadidentitypoolproviders.iam.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Spec

Schema

attributeCondition: string
attributeMapping:
  string: string
aws:
  accountId: string
  stsUri:
  - string
description: string
disabled: boolean
displayName: string
location: string
oidc:
  allowedAudiences:
  - string
  issuerUri: string
projectRef:
  external: string
  name: string
  namespace: string
resourceID: string
workloadIdentityPoolRef:
  external: string
  name: string
  namespace: string
Fields

attributeCondition

Optional

string

[A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ```

attributeMapping

Optional

map (key: string, value: string)

Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 characters. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```

aws

Optional

object

An Amazon Web Services identity provider.

aws.accountId

Required*

string

Required. The AWS account ID.

aws.stsUri

Optional

list (string)

A list of AWS STS URIs that can be used when exchanging credentials. If not provided, any valid AWS STS URI is allowed. URIs must use the form `https://sts.amazonaws.com` or `https://sts.{region}.amazonaws.com`, where {region} is a valid AWS region. You can specify a maximum of 25 URIs.

aws.stsUri[]

Optional

string

description

Optional

string

A description for the provider. Cannot exceed 256 characters.

disabled

Optional

boolean

Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.

displayName

Optional

string

A display name for the provider. Cannot exceed 32 characters.

location

Required

string

Immutable. The location for the resource

oidc

Optional

object

An OpenId Connect 1.0 identity provider.

oidc.allowedAudiences

Optional

list (string)

Acceptable values for the `aud` field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ``` //iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ https://iam.googleapis.com/projects//locations//workloadIdentityPools//providers/ ```

oidc.allowedAudiences[]

Optional

string

oidc.issuerUri

Required*

string

Required. The OIDC issuer URL. Must be an HTTPS endpoint.

projectRef

Required

object

Immutable. The Project that this resource belongs to.

projectRef.external

Optional

string

The project for the resource Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

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.

workloadIdentityPoolRef

Required

object

Immutable.

workloadIdentityPoolRef.external

Optional

string

The workloadIdentityPool for the resource Allowed value: The Google Cloud resource name of an `IAMWorkloadIdentityPool` resource (format: `projects/{{project}}/locations/{{location}}/workloadIdentityPools/{{name}}`).

workloadIdentityPoolRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

workloadIdentityPoolRef.namespace

Optional

string

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
state: string
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.

state

string

Output only. The state of the provider. Possible values: STATE_UNSPECIFIED, ACTIVE, DELETED

Sample YAML(s)

Aws Workload Identity Pool Provider

# Copyright 2021 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: iam.cnrm.cloud.google.com/v1beta1
kind: IAMWorkloadIdentityPoolProvider
metadata:
  name: iamwipp-sample-aws
spec:
  projectRef:
    # Replace ${PROJECT_ID?} with your project id
    external: "projects/${PROJECT_ID?}"
  location: "global"
  workloadIdentityPoolRef:
    name: "iamwipp-dep-aws"
  displayName: "sample-provider"
  description: "A sample workload identity pool provider using aws"
  disabled: false
  attributeMapping:
    google.subject: "true"
  attributeCondition: "true"
  aws:
    accountId: "999999999999"
    stsUri:
    - "https://sts.amazonaws.com/sample-sts"
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMWorkloadIdentityPool
metadata:
  name: iamwipp-dep-aws
spec:
  projectRef:
    # Replace ${PROJECT_ID?} with your project id
    external: "projects/${PROJECT_ID?}"
  location: "global"
  displayName: "sample-pool"
  description: "A sample workload identity pool using a newly created project"
  disabled: false

Oidc Workload Identity Pool Provider

# Copyright 2021 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: iam.cnrm.cloud.google.com/v1beta1
kind: IAMWorkloadIdentityPoolProvider
metadata:
  name: iamwipp-sample-oidc
spec:
  projectRef:
    # Replace ${PROJECT_ID?} with your project id
    external: "projects/${PROJECT_ID?}"
  location: "global"
  workloadIdentityPoolRef:
    name: "iamwipp-dep-oidc"
  attributeMapping:
    google.subject: "true"
  oidc:
    issuerUri: "https://example.com/"
    allowedAudiences:
    - "sample-audience"
---
apiVersion: iam.cnrm.cloud.google.com/v1beta1
kind: IAMWorkloadIdentityPool
metadata:
  name: iamwipp-dep-oidc
spec:
  projectRef:
    # Replace ${PROJECT_ID?} with your project id
    external: "projects/${PROJECT_ID?}"
  location: "global"
  displayName: "sample-pool"
  description: "A sample workload identity pool using a newly created project"
  disabled: false