.TH "GCLOUD_IAM_WORKFORCE\-POOLS_UPDATE" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud iam workforce\-pools update\fR (\fIWORKFORCE_POOL\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-disable\-programmatic\-signin\fR] [\fB\-\-disabled\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-session\-duration\fR=\fISESSION_DURATION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a workforce pool.



.SH "EXAMPLES"

The following command updates a workforce pool with ID
\f5\fImy\-workforce\-pool\fR\fR with explicit values for all required and
optional parameters:

.RS 2m
$ gcloud iam workforce\-pools update my\-workforce\-pool \e
    \-\-location=global \-\-display\-name="My Workforce Pool" \e
    \-\-description="My workforce pool description." \e
    \-\-session\-duration="7200s" \-\-disabled
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Workforce pool resource \- The workforce pool to update. The arguments in this
group can be used to specify the attributes of this resource.

This must be specified.


.RS 2m
.TP 2m
\fIWORKFORCE_POOL\fR

ID of the workforce pool or fully qualified identifier for the workforce pool.

To set the \f5workforce_pool\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5workforce_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 for the workforce pool.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5workforce_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\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

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

A description for the workforce pool. Cannot exceed 256 characters in length.

.TP 2m
\fB\-\-disable\-programmatic\-signin\fR

Disables the programmatic sign\-in for workforce pool users. Specify
\f5\-\-no\-disable\-security\-token\-exchange\fR to enable programmatic
sign\-in. For more information, refer to Obtain short\-lived tokens for
workforce identity federation at
https://cloud.google.com/iam/docs/workforce\-obtaining\-short\-lived\-credentials

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

Disables the workforce pool. You cannot use a disabled workforce pool to perform
new token exchanges or sign\-ins using any provider in the workforce pool.
Specify \f5\-\-no\-disabled\fR to enable a disabled pool.

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

A display name for the workforce pool. Cannot exceed 32 characters in length.

.TP 2m
\fB\-\-session\-duration\fR=\fISESSION_DURATION\fR

How long the Google Cloud access tokens, console sign\-in sessions, and gcloud
sign\-in sessions from this workforce pool are valid. Must be greater than 15
minutes (900s) and less than 12 hours (43200s). If not configured, minted
credentials will have a default duration of one hour (3600s).


.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 workforce\-pools update
.RE

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