gcloud alpha iam workforce-pools update

NAME
gcloud alpha iam workforce-pools update - update a workforce pool
SYNOPSIS
gcloud alpha iam workforce-pools update(WORKFORCE_POOL :--location=LOCATION)[--async][--description=DESCRIPTION][--disable-programmatic-signin][--disabled][--display-name=DISPLAY_NAME][--session-duration=SESSION_DURATION][GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Update a workforce pool.
EXAMPLES
The following command updates a workforce pool with IDmy-workforce-pool with explicit values forall required and optional parameters:
gcloudalphaiamworkforce-poolsupdatemy-workforce-pool--location=global--display-name="My Workforce Pool"--description="My workforce pool description."--session-duration="7200s"--disabled
POSITIONAL ARGUMENTS
Workforce pool resource - The workforce pool to update. The arguments in thisgroup can be used to specify the attributes of this resource.

This must be specified.

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

To set theworkforce_pool attribute:

  • provide the argumentworkforce_pool on the command line.

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

--location=LOCATION
The location for the workforce pool.

To set thelocation attribute:

  • provide the argumentworkforce_pool on the command line with afully specified name;
  • provide the argument--location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION
A description for the workforce pool. Cannot exceed 256 characters in length.
--disable-programmatic-signin
Disables the programmatic sign-in for workforce pool users. Specify--no-disable-security-token-exchange to enable programmaticsign-in. For more information, refer to Obtain short-lived tokens for workforceidentity federation athttps://cloud.google.com/iam/docs/workforce-obtaining-short-lived-credentials
--disabled
Disables the workforce pool. You cannot use a disabled workforce pool to performnew token exchanges or sign-ins using any provider in the workforce pool.Specify--no-disabled to enable a disabled pool.
--display-name=DISPLAY_NAME
A display name for the workforce pool. Cannot exceed 32 characters in length.
--session-duration=SESSION_DURATION
How long the Google Cloud access tokens, console sign-in sessions, and gcloudsign-in sessions from this workforce pool are valid. Must be greater than 15minutes (900s) and less than 12 hours (43200s). If not configured, mintedcredentials will have a default duration of one hour (3600s).
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 help for details.

API REFERENCE
This command uses theiam/v1 API. The full documentation for thisAPI can be found at:https://cloud.google.com/iam/
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudiamworkforce-poolsupdate
gcloudbetaiamworkforce-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 2025-05-07 UTC.