Skip to main content

workload_identity_pool_providers

Creates, updates, deletes, gets or lists a workload_identity_pool_providers resource.

Overview​

Nameworkload_identity_pool_providers
TypeResource
Idgoogle.iam.workload_identity_pool_providers

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The resource name of the provider.
attributeConditionstringOptional. A Common Expression Language 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"
attributeMappingobjectOptional. 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 bytes. * 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"}
awsobjectAn Amazon Web Services identity provider. (id: Aws)
descriptionstringOptional. A description for the provider. Cannot exceed 256 characters.
disabledbooleanOptional. Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
displayNamestringOptional. A display name for the provider. Cannot exceed 32 characters.
expireTimestring (google-datetime)Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered.
oidcobjectAn OpenId Connect 1.0 identity provider. (id: Oidc)
samlobjectAn SAML 2.0 identity provider. (id: Saml)
statestringOutput only. The state of the provider.
x509objectAn X.509-type identity provider. (id: X509)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, workloadIdentityPoolsId, providersIdGets an individual WorkloadIdentityPoolProvider.
listselectprojectsId, locationsId, workloadIdentityPoolsIdpageSize, pageToken, showDeletedLists all non-deleted WorkloadIdentityPoolProviders in a WorkloadIdentityPool. If show_deleted is set to true, then deleted providers are also listed.
createinsertprojectsId, locationsId, workloadIdentityPoolsIdworkloadIdentityPoolProviderIdCreates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion.
patchupdateprojectsId, locationsId, workloadIdentityPoolsId, providersIdupdateMaskUpdates an existing WorkloadIdentityPoolProvider.
deletedeleteprojectsId, locationsId, workloadIdentityPoolsId, providersIdDeletes a WorkloadIdentityPoolProvider. Deleting a provider does not revoke credentials that have already been issued; they continue to grant access. You can undelete a provider for 30 days. After 30 days, deletion is permanent. You cannot update deleted providers. However, you can view and list them.
undeleteexecprojectsId, locationsId, workloadIdentityPoolsId, providersIdUndeletes a WorkloadIdentityPoolProvider, as long as it was deleted fewer than 30 days ago.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
providersIdstring
workloadIdentityPoolsIdstring
pageSizeinteger (int32)
pageTokenstring
showDeletedboolean
updateMaskstring (google-fieldmask)
workloadIdentityPoolProviderIdstring

SELECT examples​

Gets an individual WorkloadIdentityPoolProvider.

SELECT
name,
attributeCondition,
attributeMapping,
aws,
description,
disabled,
displayName,
expireTime,
oidc,
saml,
state,
x509
FROM google.iam.workload_identity_pool_providers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required;

INSERT examples​

Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion.

INSERT INTO google.iam.workload_identity_pool_providers (
data__name,
data__displayName,
data__description,
data__disabled,
data__attributeMapping,
data__attributeCondition,
data__aws,
data__oidc,
data__saml,
data__x509,
projectsId,
locationsId,
workloadIdentityPoolsId,
workloadIdentityPoolProviderId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
{{ disabled }},
'{{ attributeMapping }}',
'{{ attributeCondition }}',
'{{ aws }}',
'{{ oidc }}',
'{{ saml }}',
'{{ x509 }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ workloadIdentityPoolsId }}',
'{{ workloadIdentityPoolProviderId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates an existing WorkloadIdentityPoolProvider.

UPDATE google.iam.workload_identity_pool_providers
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__attributeMapping = '{{ attributeMapping }}',
data__attributeCondition = '{{ attributeCondition }}',
data__aws = '{{ aws }}',
data__oidc = '{{ oidc }}',
data__saml = '{{ saml }}',
data__x509 = '{{ x509 }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a WorkloadIdentityPoolProvider. Deleting a provider does not revoke credentials that have already been issued; they continue to grant access. You can undelete a provider for 30 days. After 30 days, deletion is permanent. You cannot update deleted providers. However, you can view and list them.

DELETE FROM google.iam.workload_identity_pool_providers
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}' --required
AND providersId = '{{ providersId }}' --required;

Lifecycle Methods​

Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted fewer than 30 days ago.

EXEC google.iam.workload_identity_pool_providers.undelete 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@workloadIdentityPoolsId='{{ workloadIdentityPoolsId }}' --required, 
@providersId='{{ providersId }}' --required;