Class: Google::Apis::IamV1::WorkforcePoolProvider

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/iam_v1/classes.rb,
lib/google/apis/iam_v1/representations.rb,
lib/google/apis/iam_v1/representations.rb

Overview

A configuration for an external identity provider.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkforcePoolProvider

Returns a new instance of WorkforcePoolProvider.



3022
3023
3024
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3022

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attribute_condition ⇒ String

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" Corresponds to the JSON property attributeCondition

Returns:

  • (String) 


2922
2923
2924
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2922

def attribute_condition
  @attribute_condition
end

#attribute_mapping ⇒ Hash<String,String>

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`, wherecustom_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 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"` Corresponds to the JSON property attributeMapping

Returns:

  • (Hash<String,String>) 


2967
2968
2969
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2967

def attribute_mapping
  @attribute_mapping
end

#description ⇒ String

A user-specified description of the provider. Cannot exceed 256 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2972
2973
2974
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2972

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

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

Returns:

  • (Boolean) 


2978
2979
2980
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2978

def disabled
  @disabled
end

#display_name ⇒ String

A user-specified display name for the provider. Cannot exceed 32 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


2984
2985
2986
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2984

def display_name
  @display_name
end

#expire_time ⇒ String

Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered. Corresponds to the JSON property expireTime

Returns:

  • (String) 


2990
2991
2992
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2990

def expire_time
  @expire_time
end

#extra_attributes_oauth2_client ⇒ Google::Apis::IamV1::GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client

Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker. ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. Corresponds to the JSON property extraAttributesOauth2Client

Returns:



2999
3000
3001
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2999

def extra_attributes_oauth2_client
  @extra_attributes_oauth2_client
end

#name ⇒ String

Output only. The resource name of the provider. Format: locations/location/ workforcePools/workforce_pool_id/providers/provider_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


3005
3006
3007
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3005

def name
  @name
end

#oidc ⇒ Google::Apis::IamV1::GoogleIamAdminV1WorkforcePoolProviderOidc

Represents an OpenId Connect 1.0 identity provider. Corresponds to the JSON property oidc

Returns:



3010
3011
3012
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3010

def oidc
  @oidc
end

#saml ⇒ Google::Apis::IamV1::GoogleIamAdminV1WorkforcePoolProviderSaml

Represents a SAML identity provider. Corresponds to the JSON property saml

Returns:



3015
3016
3017
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3015

def saml
  @saml
end

#state ⇒ String

Output only. The state of the provider. Corresponds to the JSON property state

Returns:

  • (String) 


3020
3021
3022
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3020

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3027

def update!(**args)
  @attribute_condition = args[:attribute_condition] if args.key?(:attribute_condition)
  @attribute_mapping = args[:attribute_mapping] if args.key?(:attribute_mapping)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @extra_attributes_oauth2_client = args[:extra_attributes_oauth2_client] if args.key?(:extra_attributes_oauth2_client)
  @name = args[:name] if args.key?(:name)
  @oidc = args[:oidc] if args.key?(:oidc)
  @saml = args[:saml] if args.key?(:saml)
  @state = args[:state] if args.key?(:state)
end