Struct WorkforcePoolProvider

pub struct WorkforcePoolProvider {
    pub attribute_condition: Option<String>,
    pub attribute_mapping: Option<HashMap<String, String>>,
    pub description: Option<String>,
    pub disabled: Option<bool>,
    pub display_name: Option<String>,
    pub expire_time: Option<DateTime<Utc>>,
    pub extra_attributes_oauth2_client: Option<GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client>,
    pub name: Option<String>,
    pub oidc: Option<GoogleIamAdminV1WorkforcePoolProviderOidc>,
    pub saml: Option<GoogleIamAdminV1WorkforcePoolProviderSaml>,
    pub state: Option<String>,
}

A configuration for an external identity provider.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• workforce pools providers create locations (request)
• workforce pools providers get locations (response)
• workforce pools providers patch locations (request)

Fields

attribute_condition: Option<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"

attribute_mapping: Option<HashMap<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}, 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"}

description: Option<String>

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

disabled: Option<bool>

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

display_name: Option<String>

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

expire_time: Option<DateTime<Utc>>

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

extra_attributes_oauth2_client: Option<GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2Client>

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.

name: Option<String>

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

oidc: Option<GoogleIamAdminV1WorkforcePoolProviderOidc>

An OpenId Connect 1.0 identity provider configuration.

saml: Option<GoogleIamAdminV1WorkforcePoolProviderSaml>

A SAML identity provider configuration.

state: Option<String>

Output only. The state of the provider.

Trait Implementations

impl Clone for WorkforcePoolProvider

fn clone(&self) -> WorkforcePoolProvider

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkforcePoolProvider

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WorkforcePoolProvider

fn default() -> WorkforcePoolProvider

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkforcePoolProvider

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkforcePoolProvider

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for WorkforcePoolProvider

impl ResponseResult for WorkforcePoolProvider