Class: Google::Iam::V1beta::WorkloadIdentityPoolProvider

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/iam/v1beta/workload_identity_pool.rb

Overview

A configuration for an external identity provider.

Defined Under Namespace

Modules: State Classes: AttributeMappingEntry, Aws, Oidc

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_condition ⇒ ::String

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

Returns:

  • (::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.
    • 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"



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#attribute_mapping ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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 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, the following rules apply:

  • 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, the following rules apply:

  • Custom attribute mappings must be defined, and must include a mapping to 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:

  • (::Google::Protobuf::Map{::String => ::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 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, the following rules apply:

    • 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, the following rules apply:

    • Custom attribute mappings must be defined, and must include a mapping to 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"}



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#aws ⇒ ::Google::Iam::V1beta::WorkloadIdentityPoolProvider::Aws

Returns An Amazon Web Services identity provider.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#description ⇒ ::String

Returns A description for the provider. Cannot exceed 256 characters.

Returns:

  • (::String) —

    A description for the provider. Cannot exceed 256 characters.



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#disabled ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the provider.

Returns:

  • (::String) —

    Output only. The resource name of the provider.



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#oidc ⇒ ::Google::Iam::V1beta::WorkloadIdentityPoolProvider::Oidc

Returns An OpenId Connect 1.0 identity provider.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end

#state ⇒ ::Google::Iam::V1beta::WorkloadIdentityPoolProvider::State (readonly)

Returns Output only. The state of the provider.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 200

class WorkloadIdentityPoolProvider
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents an Amazon Web Services identity provider.
  # @!attribute [rw] account_id
  #   @return [::String]
  #     Required. The AWS account ID.
  class Aws
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Represents an OpenId Connect 1.0 identity provider.
  # @!attribute [rw] issuer_uri
  #   @return [::String]
  #     Required. The OIDC issuer URL.
  # @!attribute [rw] allowed_audiences
  #   @return [::Array<::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/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id>
  #     ```
  class Oidc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AttributeMappingEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current state of the provider.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The provider is active, and may be used to validate authentication
    # credentials.
    ACTIVE = 1

    # The provider is soft-deleted. Soft-deleted providers are permanently
    # deleted after approximately 30 days. You can restore a soft-deleted
    # provider using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool_provider UndeleteWorkloadIdentityPoolProvider}.
    #
    # You cannot reuse the ID of a soft-deleted provider until it is
    # permanently deleted.
    DELETED = 2
  end
end