1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-09 19:06:53 +00:00
gcloud-help/gcloud/alpha/iam/workforce-pools/create
2023-11-09 11:45:52 +00:00

110 lines
4.1 KiB
Text

NAME
gcloud alpha iam workforce-pools create - create a new workforce pool under
an organization
SYNOPSIS
gcloud alpha iam workforce-pools create
(WORKFORCE_POOL : --location=LOCATION) --organization=ORGANIZATION
[--allowed-services=[domain=DOMAIN]] [--async]
[--description=DESCRIPTION] [--disable-programmatic-signin]
[--disabled] [--display-name=DISPLAY_NAME]
[--session-duration=SESSION_DURATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Creates a workforce pool under an organization given a valid
organization ID.
EXAMPLES
The following command creates a workforce pool with ID my-workforce-pool in
the organization 12345:
$ gcloud alpha iam workforce-pools create my-workforce-pool \
--organization=12345
The following command creates a workforce pool with ID my-workforce-pool
with explicit values for all required and optional parameters:
$ gcloud alpha iam workforce-pools create my-workforce-pool \
--organization=12345 --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 create. 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.
REQUIRED FLAGS
--organization=ORGANIZATION
The parent organization of the workforce pool to create.
OPTIONAL FLAGS
--allowed-services=[domain=DOMAIN]
Services allowed for web sign-in with the workforce pool. The flag
accepts multiple values with the key as domain and value as the domain
of the service allowed for web sign-in. If not set, by default all the
services are allowed.
--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
Disable programmatic sign-in for workforce pool users.
--disabled
Whether or not the workforce pool is disabled.
--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.
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 create
$ gcloud beta iam workforce-pools create