Class WorkforcePoolProvider
A configuration for an external identity provider.
Implements
Inherited Members
Namespace: Google.Apis.Iam.v1.Data
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class WorkforcePoolProvider : IDirectResponseSchema
Properties
AttributeCondition
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"
Declaration
[JsonProperty("attributeCondition")]
public virtual string AttributeCondition { get; set; }
Property Value
Type | Description |
---|---|
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/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"}
Declaration
[JsonProperty("attributeMapping")]
public virtual IDictionary<string, string> AttributeMapping { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Description
A user-specified description of the provider. Cannot exceed 256 characters.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
Disabled
Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DisplayName
A user-specified display name for the provider. Cannot exceed 32 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ExpireTime
object representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type | Description |
---|---|
object |
ExpireTimeDateTimeOffset
DateTimeOffset representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
ExpireTimeRaw
Output only. Time after which the workload pool provider will be permanently purged and cannot be recovered.
Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("extraAttributesOauth2Client")]
public virtual GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client ExtraAttributesOauth2Client { get; set; }
Property Value
Type | Description |
---|---|
GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client |
Name
Output only. The resource name of the provider. Format:
locations/{location}/workforcePools/{workforce_pool_id}/providers/{provider_id}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Oidc
An OpenId Connect 1.0 identity provider configuration.
Declaration
[JsonProperty("oidc")]
public virtual GoogleIamAdminV1WorkforcePoolProviderOidc Oidc { get; set; }
Property Value
Type | Description |
---|---|
GoogleIamAdminV1WorkforcePoolProviderOidc |
Saml
A SAML identity provider configuration.
Declaration
[JsonProperty("saml")]
public virtual GoogleIamAdminV1WorkforcePoolProviderSaml Saml { get; set; }
Property Value
Type | Description |
---|---|
GoogleIamAdminV1WorkforcePoolProviderSaml |
State
Output only. The state of the provider.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |