gcloud iam workload-identity-pools update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud iam workload-identity-pools update - update a workload identity pool
- SYNOPSIS
gcloud iam workload-identity-pools update(WORKLOAD_IDENTITY_POOL:--location=LOCATION)[--description=DESCRIPTION][--disabled][--display-name=DISPLAY_NAME][--inline-trust-config-file=INLINE_TRUST_CONFIG_FILE][--inline-certificate-issuance-config-file=INLINE_CERTIFICATE_ISSUANCE_CONFIG_FILE|--certificate-lifetime=CERTIFICATE_LIFETIME--key-algorithm=KEY_ALGORITHM--rotation-window-percentage=ROTATION_WINDOW_PERCENTAGE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update a workload identity pool.
- EXAMPLES
- The following command updates the workload identity pool with the ID
:my-workload-identity-poolgcloudiamworkload-identity-poolsupdatemy-workload-identity-pool--location="global"--display-name="My workload pool"--description="My workload pool description"--disabled - POSITIONAL ARGUMENTS
- Workload identity pool resource - The workload identity pool to update. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
To set the
projectattribute:- provide the argument
workload_identity_poolon the command linewith a fully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
WORKLOAD_IDENTITY_POOL- ID of the workload identity pool or fully qualified identifier for the workloadidentity pool.
To set the
workload_identity_poolattribute:- provide the argument
workload_identity_poolon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The location name.
To set the
locationattribute:- provide the argument
workload_identity_poolon the command linewith a fully specified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Workload identity pool resource - The workload identity pool to update. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.
- FLAGS
--description=DESCRIPTION- A description of the pool. Cannot exceed 256 characters.
--disabled- Whether the pool is disabled. You cannot use a disabled pool to exchange tokens,or use existing tokens to access resources. If the pool is re-enabled, existingtokens grant access again.
--display-name=DISPLAY_NAME- A display name for the pool. Cannot exceed 32 characters.
--inline-trust-config-file=INLINE_TRUST_CONFIG_FILE- YAML file with configuration for providing additional trust bundles. Examplefile format:
inlineTrustConfig:additionalTrustBundles:example.com:trustAnchors:-pemCertificate:"-----BEGINCERTIFICATE-----<certificate>-----ENDCERTIFICATE-----"-pemCertificate:"-----BEGINCERTIFICATE-----<certificate>-----ENDCERTIFICATE-----"myorg.com:trustAnchors:-pemCertificate:"-----BEGINCERTIFICATE-----<certificate>-----ENDCERTIFICATE-----"-pemCertificate:"-----BEGINCERTIFICATE-----<certificate>-----ENDCERTIFICATE-----"
- At most one of these can be specified:
--inline-certificate-issuance-config-file=INLINE_CERTIFICATE_ISSUANCE_CONFIG_FILE- YAML file with configuration for certificate issuance. Example file format:
inlineCertificateIssuanceConfig:caPools:us-east1:projects/1234/locations/us-east1/caPools/capoolnameus-west1:projects/1234/locations/us-west1/caPools/capoolnamekeyAlgorithm:ECDSA_P256lifetime:86400srotationWindowPercentage:50
- Or at least one of these can be specified:
--certificate-lifetime=CERTIFICATE_LIFETIME- Lifetime of the workload certificates issued by the CA pool.
--key-algorithm=KEY_ALGORITHM- Key algorithm to use when generating the key pair. This key pair will be used tocreate the certificate.
KEY_ALGORITHMmust be one of:ecdsa-p256,ecdsa-p384,key-algorithm-unspecified,rsa-2048,rsa-3072,rsa-4096. --rotation-window-percentage=ROTATION_WINDOW_PERCENTAGE- Rotation window percentage indicating when certificate rotation should beinitiated based on remaining lifetime.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--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 helpfor details. - API REFERENCE
- This command uses the
iam/v1API. The full documentation for thisAPI can be found at:https://cloud.google.com/iam/ - NOTES
- These variants are also available:
gcloudalphaiamworkload-identity-poolsupdategcloudbetaiamworkload-identity-poolsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.