HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/help/man/man1/gcloud_iam_workload-identity-pools_update.1
.TH "GCLOUD_IAM_WORKLOAD\-IDENTITY\-POOLS_UPDATE" 1



.SH "NAME"
.HP
gcloud iam workload\-identity\-pools update \- update a workload identity pool



.SH "SYNOPSIS"
.HP
\f5gcloud iam workload\-identity\-pools update\fR (\fIWORKLOAD_IDENTITY_POOL\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-disabled\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-inline\-trust\-config\-file\fR=\fIINLINE_TRUST_CONFIG_FILE\fR] [\fB\-\-inline\-certificate\-issuance\-config\-file\fR=\fIINLINE_CERTIFICATE_ISSUANCE_CONFIG_FILE\fR\ |\ \fB\-\-certificate\-lifetime\fR=\fICERTIFICATE_LIFETIME\fR\ \fB\-\-key\-algorithm\fR=\fIKEY_ALGORITHM\fR\ \fB\-\-rotation\-window\-percentage\fR=\fIROTATION_WINDOW_PERCENTAGE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a workload identity pool.



.SH "EXAMPLES"

The following command updates the workload identity pool with the ID
\f5\fImy\-workload\-identity\-pool\fR\fR:

.RS 2m
$ gcloud iam workload\-identity\-pools update \e
    my\-workload\-identity\-pool \-\-location="global" \e
    \-\-display\-name="My workload pool" \e
    \-\-description="My workload pool description" \-\-disabled
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Workload identity pool resource \- The workload identity pool to update. The
arguments 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 in
other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5workload_identity_pool\fR on the command line with a
fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIWORKLOAD_IDENTITY_POOL\fR

ID of the workload identity pool or fully qualified identifier for the workload
identity pool.

To set the \f5workload_identity_pool\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5workload_identity_pool\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location name.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5workload_identity_pool\fR on the command line with a
fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

A description of the pool. Cannot exceed 256 characters.

.TP 2m
\fB\-\-disabled\fR

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, existing
tokens grant access again.

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

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

.TP 2m
\fB\-\-inline\-trust\-config\-file\fR=\fIINLINE_TRUST_CONFIG_FILE\fR

YAML file with configuration for providing additional trust bundles. Example
file format:.RS 2m
inlineTrustConfig:
  additionalTrustBundles:
    example.com:
      trustAnchors:
      \- pemCertificate: "\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
        <certificate>
        \-\-\-\-\-END CERTIFICATE\-\-\-\-\-"
      \- pemCertificate: "\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
        <certificate>
        \-\-\-\-\-END CERTIFICATE\-\-\-\-\-"
    myorg.com:
      trustAnchors:
      \- pemCertificate: "\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
        <certificate>
        \-\-\-\-\-END CERTIFICATE\-\-\-\-\-"
      \- pemCertificate: "\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
        <certificate>
        \-\-\-\-\-END CERTIFICATE\-\-\-\-\-"

.RE

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-inline\-certificate\-issuance\-config\-file\fR=\fIINLINE_CERTIFICATE_ISSUANCE_CONFIG_FILE\fR

YAML file with configuration for certificate issuance. Example file format:.RS 2m
inlineCertificateIssuanceConfig:
  caPools:
    us\-east1: projects/1234/locations/us\-east1/caPools/capoolname
    us\-west1: projects/1234/locations/us\-west1/caPools/capoolname
  keyAlgorithm: ECDSA_P256
  lifetime: 86400s
  rotationWindowPercentage: 50

.RE

.TP 2m
\fB\-\-certificate\-lifetime\fR=\fICERTIFICATE_LIFETIME\fR

Lifetime of the workload certificates issued by the CA pool.

.TP 2m
\fB\-\-key\-algorithm\fR=\fIKEY_ALGORITHM\fR

Key algorithm to use when generating the key pair. This key pair will be used to
create the certificate. \fIKEY_ALGORITHM\fR must be one of: \fBecdsa\-p256\fR,
\fBecdsa\-p384\fR, \fBkey\-algorithm\-unspecified\fR, \fBrsa\-2048\fR,
\fBrsa\-3072\fR, \fBrsa\-4096\fR.

.TP 2m
\fB\-\-rotation\-window\-percentage\fR=\fIROTATION_WINDOW_PERCENTAGE\fR

Rotation window percentage indicating when certificate rotation should be
initiated based on remaining lifetime.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBiam/v1\fR API. The full documentation for this API can
be found at: https://cloud.google.com/iam/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha iam workload\-identity\-pools update
.RE

.RS 2m
$ gcloud beta iam workload\-identity\-pools update
.RE