gcloud iam workload-identity-pools providers create-saml (PROVIDER : --location=LOCATION --workload-identity-pool=WORKLOAD_IDENTITY_POOL) --attribute-mapping=[KEY=VALUE,…] --idp-metadata-path=PATH_TO_FILE [--attribute-condition=ATTRIBUTE_CONDITION] [--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG …]
my-workload-identity-pool-provider.
Explicit values for all required and optional parameters are provided.
gcloud iam workload-identity-pools providers create-saml my-workload-identity-pool-provider --location="global" --workload-identity-pool="my-workload-identity-pool" --display-name="My workload pool provider" --description="My workload pool provider description" --disabled --attribute-mapping="google.subject=assertion.sub" --attribute-condition="true" --idp-metadata-path="path/to/metadata/file.xml"
To set the project attribute:
provider on the command line with a fully
specified name;
--project on the command line;
core/project.
PROVIDER
To set the provider attribute:
provider on the command line.
--location=LOCATIONlocation attribute:
provider on the command line with a fully
specified name;
--location on the command line.
--workload-identity-pool=WORKLOAD_IDENTITY_POOLgcp- is reserved for use by Google, and may
not be specified.
To set the workload-identity-pool attribute:
provider on the command line with a fully
specified name;
--workload-identity-pool on the command line.
--attribute-mapping=[KEY=VALUE,…]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 bytes.
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 can 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:
{ "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", }
google.subject attribute.
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"}
--idp-metadata-path=PATH_TO_FILE--attribute-condition=ATTRIBUTE_CONDITIONThe 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"--description=DESCRIPTION--disabled--display-name=DISPLAY_NAME--access-token-file,
--account, --billing-project,
--configuration,
--flags-file,
--flatten, --format, --help, --impersonate-service-account,
--log-http,
--project, --quiet, --trace-token, --user-output-enabled,
--verbosity.
Run $ gcloud help for details.
iam/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/iam/
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.