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 ID my-workforce-pool with explicit values for all required and optional parameters:
gcloud alpha iam workforce-pools update my-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 this group 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 the workforce_pool attribute:

  • provide the argument workforce_pool on the command line.

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

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

To set the location attribute:

  • provide the argument workforce_pool on the command line with a fully 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 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
--disabled
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 --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 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).
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 the iam/v1 API. The full documentation for this API can be found at: https://cloud.google.com/iam/
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:
gcloud iam workforce-pools update
gcloud beta iam workforce-pools update