com.google.api.services.iam.v1.model

Class WorkforcePoolProvider

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.iam.v1.model.WorkforcePoolProvider

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class WorkforcePoolProvider
extends com.google.api.client.json.GenericJson

A configuration for an external identity provider.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Identity and Access Management (IAM) API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
WorkforcePoolProvider()

Method Summary

Modifier and Type	Method and Description
WorkforcePoolProvider	clone()
String	getAttributeCondition() Optional.
Map<String,String>	getAttributeMapping() Required.
String	getDescription() Optional.
Boolean	getDisabled() Optional.
String	getDisplayName() Optional.
String	getExpireTime() Output only.
GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client	getExtraAttributesOauth2Client() Optional.
String	getName() Output only.
GoogleIamAdminV1WorkforcePoolProviderOidc	getOidc() An OpenId Connect 1.0 identity provider configuration.
GoogleIamAdminV1WorkforcePoolProviderSaml	getSaml() A SAML identity provider configuration.
String	getState() Output only.
WorkforcePoolProvider	set(String fieldName, Object value)
WorkforcePoolProvider	setAttributeCondition(String attributeCondition) Optional.
WorkforcePoolProvider	setAttributeMapping(Map<String,String> attributeMapping) Required.
WorkforcePoolProvider	setDescription(String description) Optional.
WorkforcePoolProvider	setDisabled(Boolean disabled) Optional.
WorkforcePoolProvider	setDisplayName(String displayName) Optional.
WorkforcePoolProvider	setExpireTime(String expireTime) Output only.
WorkforcePoolProvider	setExtraAttributesOauth2Client(GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client extraAttributesOauth2Client) Optional.
WorkforcePoolProvider	setName(String name) Output only.
WorkforcePoolProvider	setOidc(GoogleIamAdminV1WorkforcePoolProviderOidc oidc) An OpenId Connect 1.0 identity provider configuration.
WorkforcePoolProvider	setSaml(GoogleIamAdminV1WorkforcePoolProviderSaml saml) A SAML identity provider configuration.
WorkforcePoolProvider	setState(String state) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

WorkforcePoolProvider

public WorkforcePoolProvider()

Method Detail

getAttributeCondition

public String getAttributeCondition()

Optional. 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`. `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" ```

Returns:

value or null for none

setAttributeCondition

public WorkforcePoolProvider setAttributeCondition(String attributeCondition)

Optional. 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`. `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" ```

Parameters:

attributeCondition - attributeCondition or null for none

getAttributeMapping

public Map<String,String> getAttributeMapping()

Required. 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/workforcePo ols/{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"} ```

Returns:

value or null for none

setAttributeMapping

public WorkforcePoolProvider setAttributeMapping(Map<String,String> attributeMapping)

Required. 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/workforcePo ols/{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"} ```

Parameters:

attributeMapping - attributeMapping or null for none

getDescription

public String getDescription()

Optional. A user-specified description of the provider. Cannot exceed 256 characters.

Returns:

value or null for none

setDescription

public WorkforcePoolProvider setDescription(String description)

Optional. A user-specified description of the provider. Cannot exceed 256 characters.

Parameters:

description - description or null for none

getDisabled

public Boolean getDisabled()

Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.

Returns:

value or null for none

setDisabled

public WorkforcePoolProvider setDisabled(Boolean disabled)

Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

Optional. A user-specified display name for the provider. Cannot exceed 32 characters.

Returns:

value or null for none

setDisplayName

public WorkforcePoolProvider setDisplayName(String displayName)

Optional. A user-specified display name for the provider. Cannot exceed 32 characters.

Parameters:

displayName - displayName or null for none

getExpireTime

public String getExpireTime()

Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.

Returns:

value or null for none

setExpireTime

public WorkforcePoolProvider setExpireTime(String expireTime)

Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.

Parameters:

expireTime - expireTime or null for none

getExtraAttributesOauth2Client

public GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client getExtraAttributesOauth2Client()

Optional. 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.

Returns:

value or null for none

setExtraAttributesOauth2Client

public WorkforcePoolProvider setExtraAttributesOauth2Client(GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client extraAttributesOauth2Client)

Optional. 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.

Parameters:

extraAttributesOauth2Client - extraAttributesOauth2Client or null for none

getName

public String getName()

Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

Returns:

value or null for none

setName

public WorkforcePoolProvider setName(String name)

Output only. The resource name of the provider. Format: `locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}`

Parameters:

name - name or null for none

getOidc

public GoogleIamAdminV1WorkforcePoolProviderOidc getOidc()

An OpenId Connect 1.0 identity provider configuration.

Returns:

value or null for none

setOidc

public WorkforcePoolProvider setOidc(GoogleIamAdminV1WorkforcePoolProviderOidc oidc)

An OpenId Connect 1.0 identity provider configuration.

Parameters:

oidc - oidc or null for none

getSaml

public GoogleIamAdminV1WorkforcePoolProviderSaml getSaml()

A SAML identity provider configuration.

Returns:

value or null for none

setSaml

public WorkforcePoolProvider setSaml(GoogleIamAdminV1WorkforcePoolProviderSaml saml)

A SAML identity provider configuration.

Parameters:

saml - saml or null for none

getState

public String getState()

Output only. The state of the provider.

Returns:

value or null for none

setState

public WorkforcePoolProvider setState(String state)

Output only. The state of the provider.

Parameters:

state - state or null for none

set

public WorkforcePoolProvider set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public WorkforcePoolProvider clone()

Overrides:

clone in class com.google.api.client.json.GenericJson