Skip to main content

workforce_pool_providers

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

Overview​

Nameworkforce_pool_providers
TypeResource
Idgoogle.iam.workforce_pool_providers

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The resource name of the provider. Format: locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}
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. google.profile_photo, google.display_name and google.posix_username are not supported. * 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 credentials will be accepted. The following example shows how to only allow credentials with a mapped google.groups value of admins: "'admins' in google.groups"
attributeMappingobjectRequired. Maps attributes from the 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. This is a required field and the mapped subject cannot exceed 127 bytes. * google.groups: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM principalSet binding; access applies to all members of the group. * google.display_name: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, google.subject will be displayed instead. This attribute cannot be referenced in IAM bindings. * google.profile_photo: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * google.posix_username: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9.{0,31}$". This attribute cannot be referenced in IAM bindings. 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 workforce pool to Google Cloud resources. For example: * google.subject: principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value} * google.groups: principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value} * attribute.{custom_attribute}: principalSet://iam.googleapis.com/locations/global/workforcePools/{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 4KB. For OIDC providers, you must supply a custom mapping that includes 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"}
descriptionstringOptional. A user-specified description of the provider. Cannot exceed 256 characters.
detailedAuditLoggingbooleanOptional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in sts.googleapis.com data access logs. Default value is false.
disabledbooleanOptional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
displayNamestringOptional. A user-specified display name for the provider. Cannot exceed 32 characters.
expireTimestring (google-datetime)Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.
extendedAttributesOauth2ClientobjectOptional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the AZURE_AD_GROUPS_ID attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped google.groups attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user. (id: GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client)
extraAttributesOauth2ClientobjectOptional. The configuration for OAuth 2.0 client used to get the additional user attributes. This should be used when users can't get the desired claims in authentication credentials. Currently this configuration is only supported with OIDC protocol. (id: GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client)
oidcobjectAn OpenId Connect 1.0 identity provider configuration. (id: GoogleIamAdminV1WorkforcePoolProviderOidc)
samlobjectA SAML identity provider configuration. (id: GoogleIamAdminV1WorkforcePoolProviderSaml)
statestringOutput only. The state of the provider.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlocationsId, workforcePoolsId, providersIdGets an individual WorkforcePoolProvider.
listselectlocationsId, workforcePoolsIdpageSize, pageToken, showDeletedLists all non-deleted WorkforcePoolProviders in a WorkforcePool. If show_deleted is set to true, then deleted providers are also listed.
createinsertlocationsId, workforcePoolsIdworkforcePoolProviderIdCreates a new WorkforcePoolProvider in a WorkforcePool. You cannot reuse the name of a deleted provider until 30 days after deletion.
patchupdatelocationsId, workforcePoolsId, providersIdupdateMaskUpdates an existing WorkforcePoolProvider.
deletedeletelocationsId, workforcePoolsId, providersIdDeletes a WorkforcePoolProvider. 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.
undeleteexeclocationsId, workforcePoolsId, providersIdUndeletes a WorkforcePoolProvider, 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
providersIdstring
workforcePoolsIdstring
pageSizeinteger (int32)
pageTokenstring
showDeletedboolean
updateMaskstring (google-fieldmask)
workforcePoolProviderIdstring

SELECT examples​

Gets an individual WorkforcePoolProvider.

SELECT
name,
attributeCondition,
attributeMapping,
description,
detailedAuditLogging,
disabled,
displayName,
expireTime,
extendedAttributesOauth2Client,
extraAttributesOauth2Client,
oidc,
saml,
state
FROM google.iam.workforce_pool_providers
WHERE locationsId = '{{ locationsId }}' -- required
AND workforcePoolsId = '{{ workforcePoolsId }}' -- required
AND providersId = '{{ providersId }}' -- required;

INSERT examples​

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

INSERT INTO google.iam.workforce_pool_providers (
data__name,
data__displayName,
data__description,
data__disabled,
data__attributeMapping,
data__attributeCondition,
data__saml,
data__oidc,
data__extraAttributesOauth2Client,
data__detailedAuditLogging,
data__extendedAttributesOauth2Client,
locationsId,
workforcePoolsId,
workforcePoolProviderId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
{{ disabled }},
'{{ attributeMapping }}',
'{{ attributeCondition }}',
'{{ saml }}',
'{{ oidc }}',
'{{ extraAttributesOauth2Client }}',
{{ detailedAuditLogging }},
'{{ extendedAttributesOauth2Client }}',
'{{ locationsId }}',
'{{ workforcePoolsId }}',
'{{ workforcePoolProviderId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates an existing WorkforcePoolProvider.

UPDATE google.iam.workforce_pool_providers
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__disabled = {{ disabled }},
data__attributeMapping = '{{ attributeMapping }}',
data__attributeCondition = '{{ attributeCondition }}',
data__saml = '{{ saml }}',
data__oidc = '{{ oidc }}',
data__extraAttributesOauth2Client = '{{ extraAttributesOauth2Client }}',
data__detailedAuditLogging = {{ detailedAuditLogging }},
data__extendedAttributesOauth2Client = '{{ extendedAttributesOauth2Client }}'
WHERE 
locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a WorkforcePoolProvider. 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.workforce_pool_providers
WHERE locationsId = '{{ locationsId }}' --required
AND workforcePoolsId = '{{ workforcePoolsId }}' --required
AND providersId = '{{ providersId }}' --required;

Lifecycle Methods​

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

EXEC google.iam.workforce_pool_providers.undelete 
@locationsId='{{ locationsId }}' --required, 
@workforcePoolsId='{{ workforcePoolsId }}' --required, 
@providersId='{{ providersId }}' --required;