mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 02:25:19 +00:00
gcloud: Wed Nov 20 10:03:22 UTC 2024
This commit is contained in:
parent
a63704a3af
commit
ad2752c6c9
198 changed files with 7874 additions and 336 deletions
|
|
@ -27,6 +27,9 @@ GCLOUD WIDE FLAGS
|
|||
GROUPS
|
||||
GROUP is one of the following:
|
||||
|
||||
oauth-clients
|
||||
Create and manage OAuth clients.
|
||||
|
||||
policies
|
||||
Manage IAM deny policies.
|
||||
|
||||
|
|
|
|||
119
gcloud/iam/oauth-clients/create
Normal file
119
gcloud/iam/oauth-clients/create
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients create - create an OAuth client
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients create (OAUTH_CLIENT : --location=LOCATION)
|
||||
--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]
|
||||
--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]
|
||||
--allowed-scopes=[ALLOWED_SCOPES,...] --client-type=CLIENT_TYPE
|
||||
[--description=DESCRIPTION] [--disabled] [--display-name=DISPLAY_NAME]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Create a new OAuth client.
|
||||
|
||||
EXAMPLES
|
||||
The following command creates a disabled OAuth client with ID
|
||||
my-oauth-client in the default project:
|
||||
|
||||
$ gcloud iam oauth-clients create my-oauth-client \
|
||||
--location="global" --client-type="confidential-client" \
|
||||
--display-name="My oauth client" \
|
||||
--description="My oauth client description" --disabled \
|
||||
--allowed-grant-types="authorization-code-grant,refresh-token-gr\
|
||||
ant" \
|
||||
--allowed-scopes="https://www.googleapis.com/auth/cloud-platform\
|
||||
,openid" --allowed-redirect-uris="https://example.com"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client resource - The OAuth client to create. 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 project attribute:
|
||||
◆ provide the argument oauth_client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth_client attribute:
|
||||
▸ provide the argument oauth_client 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument oauth_client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]
|
||||
A list of OAuth grant types that are allowed for the OAuth client.
|
||||
|
||||
The following grant types are currently supported:
|
||||
|
||||
◆ authorization-code-grant
|
||||
|
||||
◆ refresh-token-grant
|
||||
|
||||
--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]
|
||||
A list of redirect uris that is allowed for redirecting when the
|
||||
authorization is completed.
|
||||
|
||||
--allowed-scopes=[ALLOWED_SCOPES,...]
|
||||
A list of scopes that the OAuth client is allowed to request during
|
||||
OAuth flows.
|
||||
|
||||
The following scopes are currently supported:
|
||||
|
||||
◆ https://www.googleapis.com/auth/cloud-platform: View, edit,
|
||||
configure, and delete your Google Cloud data, and view the email
|
||||
address for your Google Account.
|
||||
|
||||
◆ openid: Associate you with your personal info on Google Cloud.
|
||||
|
||||
◆ email: View your Google Cloud Account email address.
|
||||
|
||||
--client-type=CLIENT_TYPE
|
||||
The type of OAuth client. CLIENT_TYPE must be one of:
|
||||
confidential-client, public-client.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--description=DESCRIPTION
|
||||
A description of the OAuth client. Cannot exceed 256 characters.
|
||||
|
||||
--disabled
|
||||
Disables the OAuth client. You cannot use a disabled OAuth client for
|
||||
login. Include --no-disabled to enable a disabled OAuth client.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
A display name for the OAuth client. Cannot exceed 32 characters.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients create
|
||||
|
||||
91
gcloud/iam/oauth-clients/credentials/create
Normal file
91
gcloud/iam/oauth-clients/credentials/create
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials create - create an OAuth client
|
||||
credential
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials create
|
||||
(CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT)
|
||||
[--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Create a new OAuth client credential.
|
||||
|
||||
EXAMPLES
|
||||
To create a disabled OAuth client credential with ID
|
||||
my-oauth-client-credential in the default project, run:
|
||||
|
||||
$ gcloud iam oauth-clients credentials create \
|
||||
my-oauth-client-credential --location="global" \
|
||||
--oauth-client="my-oauth-client" \
|
||||
--display-name="My OAuth client credential" --disabled
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client credential resource - The OAuth client credential to create.
|
||||
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 project attribute:
|
||||
◆ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CREDENTIAL
|
||||
ID of the oauth client credential or fully qualified identifier for
|
||||
the oauth client credential.
|
||||
|
||||
To set the credential attribute:
|
||||
▸ provide the argument credential 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
--oauth-client=OAUTH_CLIENT
|
||||
ID to use for the OAuth client, which becomes the final component of
|
||||
the resource name. This value should be 4-32 characters, and may
|
||||
contain the characters [a-z0-9-]. The prefix gcp- is reserved for use
|
||||
by Google, and may not be specified.
|
||||
|
||||
To set the oauth-client attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --oauth-client on the command line.
|
||||
|
||||
FLAGS
|
||||
--disabled
|
||||
Disables the OAuth client credential. You cannot use a disabled OAuth
|
||||
client credential for OAuth. Include --no-disabled to enable a disabled
|
||||
OAuth client credential.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
A display name for the OAuth client credential. Cannot exceed 32
|
||||
characters.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials create
|
||||
|
||||
80
gcloud/iam/oauth-clients/credentials/delete
Normal file
80
gcloud/iam/oauth-clients/credentials/delete
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials delete - delete an OAuth client
|
||||
credential
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials delete
|
||||
(CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Delete an OAuth client credential.
|
||||
|
||||
EXAMPLES
|
||||
To delete the OAuth client credential with ID my-oauth-client-credential in
|
||||
the default project, run:
|
||||
|
||||
$ gcloud iam oauth-clients credentials delete \
|
||||
my-oauth-client-credential --location="global" \
|
||||
--oauth-client="my-oauth-client"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client credential resource - The OAuth client credential to delete.
|
||||
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 project attribute:
|
||||
◆ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CREDENTIAL
|
||||
ID of the oauth client credential or fully qualified identifier for
|
||||
the oauth client credential.
|
||||
|
||||
To set the credential attribute:
|
||||
▸ provide the argument credential 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
--oauth-client=OAUTH_CLIENT
|
||||
ID to use for the OAuth client, which becomes the final component of
|
||||
the resource name. This value should be 4-32 characters, and may
|
||||
contain the characters [a-z0-9-]. The prefix gcp- is reserved for use
|
||||
by Google, and may not be specified.
|
||||
|
||||
To set the oauth-client attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --oauth-client on the command line.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials delete
|
||||
|
||||
80
gcloud/iam/oauth-clients/credentials/describe
Normal file
80
gcloud/iam/oauth-clients/credentials/describe
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials describe - describe an OAuth client
|
||||
credential
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials describe
|
||||
(CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Describe an OAuth client credential.
|
||||
|
||||
EXAMPLES
|
||||
To describe the OAuth client credential with ID my-oauth-client-credential
|
||||
in the default project, run:
|
||||
|
||||
$ gcloud iam oauth-clients credentials describe \
|
||||
my-oauth-client-credential --location="global" \
|
||||
--oauth-client="my-oauth-client"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client credential resource - The OAuth client credential you want to
|
||||
describe. 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 project attribute:
|
||||
◆ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CREDENTIAL
|
||||
ID of the oauth client credential or fully qualified identifier for
|
||||
the oauth client credential.
|
||||
|
||||
To set the credential attribute:
|
||||
▸ provide the argument credential 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
--oauth-client=OAUTH_CLIENT
|
||||
ID to use for the OAuth client, which becomes the final component of
|
||||
the resource name. This value should be 4-32 characters, and may
|
||||
contain the characters [a-z0-9-]. The prefix gcp- is reserved for use
|
||||
by Google, and may not be specified.
|
||||
|
||||
To set the oauth-client attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --oauth-client on the command line.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials describe
|
||||
|
||||
39
gcloud/iam/oauth-clients/credentials/help
Normal file
39
gcloud/iam/oauth-clients/credentials/help
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials - create and manage OAuth client
|
||||
credentials
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
The gcloud iam oauth-clients credentials group lets you create and manage
|
||||
OAuth client credentials for projects on the Google Cloud Platform.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
create
|
||||
Create an OAuth client credential.
|
||||
|
||||
delete
|
||||
Delete an OAuth client credential.
|
||||
|
||||
describe
|
||||
Describe an OAuth client credential.
|
||||
|
||||
list
|
||||
List OAuth client credentials.
|
||||
|
||||
update
|
||||
Update an OAuth client credential.
|
||||
|
||||
NOTES
|
||||
This variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials
|
||||
|
||||
86
gcloud/iam/oauth-clients/credentials/list
Normal file
86
gcloud/iam/oauth-clients/credentials/list
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials list - list OAuth client credentials
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials list
|
||||
(--oauth-client=OAUTH_CLIENT : --location=LOCATION)
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
List OAuth client credentials.
|
||||
|
||||
EXAMPLES
|
||||
To list all OAuth client credentials in the default project, run:
|
||||
|
||||
$ gcloud iam oauth-clients credentials list --location="global" \
|
||||
--oauth-client="my-oauth-client"
|
||||
|
||||
REQUIRED FLAGS
|
||||
Oauth client resource - The OAuth client you want to list credentials for.
|
||||
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 project attribute:
|
||||
◆ provide the argument --oauth-client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
--oauth-client=OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth-client attribute:
|
||||
▸ provide the argument --oauth-client on the command line.
|
||||
|
||||
This flag argument must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--location=LOCATION
|
||||
The location name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument --oauth-client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials list
|
||||
|
||||
91
gcloud/iam/oauth-clients/credentials/update
Normal file
91
gcloud/iam/oauth-clients/credentials/update
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients credentials update - update an OAuth client
|
||||
credential
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients credentials update
|
||||
(CREDENTIAL : --location=LOCATION --oauth-client=OAUTH_CLIENT)
|
||||
[--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Update an OAuth client credential.
|
||||
|
||||
EXAMPLES
|
||||
To update the OAuth client credential with ID my-oauth-client-credential in
|
||||
the default project, run:
|
||||
|
||||
$ gcloud iam oauth-clients credentials update \
|
||||
my-oauth-client-credential --location="global" \
|
||||
--oauth-client="my-oauth-client" \
|
||||
--display-name="My OAuth client credential" --disabled
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client credential resource - The OAuth client credential 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 project attribute:
|
||||
◆ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
CREDENTIAL
|
||||
ID of the oauth client credential or fully qualified identifier for
|
||||
the oauth client credential.
|
||||
|
||||
To set the credential attribute:
|
||||
▸ provide the argument credential 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
--oauth-client=OAUTH_CLIENT
|
||||
ID to use for the OAuth client, which becomes the final component of
|
||||
the resource name. This value should be 4-32 characters, and may
|
||||
contain the characters [a-z0-9-]. The prefix gcp- is reserved for use
|
||||
by Google, and may not be specified.
|
||||
|
||||
To set the oauth-client attribute:
|
||||
▸ provide the argument credential on the command line with a fully
|
||||
specified name;
|
||||
▸ provide the argument --oauth-client on the command line.
|
||||
|
||||
FLAGS
|
||||
--disabled
|
||||
Disables the OAuth client credential. You cannot use a disabled OAuth
|
||||
client credential for OAuth. Include --no-disabled to enable a disabled
|
||||
OAuth client credential.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
A display name for the OAuth client credential. Cannot exceed 32
|
||||
characters.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients credentials update
|
||||
|
||||
65
gcloud/iam/oauth-clients/delete
Normal file
65
gcloud/iam/oauth-clients/delete
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients delete - delete an OAuth client
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients delete (OAUTH_CLIENT : --location=LOCATION)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Delete an OAuth client.
|
||||
|
||||
EXAMPLES
|
||||
The following command deletes the OAuth client with the ID my-oauth-client
|
||||
in the default project:
|
||||
|
||||
$ gcloud iam oauth-clients delete my-oauth-client --location="global"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client resource - The OAuth client to delete. 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 project attribute:
|
||||
◆ provide the argument oauth_client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth_client attribute:
|
||||
▸ provide the argument oauth_client 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument oauth_client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients delete
|
||||
|
||||
66
gcloud/iam/oauth-clients/describe
Normal file
66
gcloud/iam/oauth-clients/describe
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients describe - describe an OAuth client
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients describe (OAUTH_CLIENT : --location=LOCATION)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Describe an OAuth client.
|
||||
|
||||
EXAMPLES
|
||||
The following command describes the OAuth client with the ID
|
||||
my-oauth-client in the default project:
|
||||
|
||||
$ gcloud iam oauth-clients describe my-oauth-client \
|
||||
--location="global"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client resource - The OAuth client you want to describe. 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 project attribute:
|
||||
◆ provide the argument oauth_client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth_client attribute:
|
||||
▸ provide the argument oauth_client 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument oauth_client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients describe
|
||||
|
||||
47
gcloud/iam/oauth-clients/help
Normal file
47
gcloud/iam/oauth-clients/help
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients - create and manage OAuth clients
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
The gcloud iam oauth-clients group lets you create and manage OAuth clients
|
||||
for projects on the Google Cloud Platform.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
GROUPS
|
||||
GROUP is one of the following:
|
||||
|
||||
credentials
|
||||
Create and manage OAuth client credentials.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
create
|
||||
Create an OAuth client.
|
||||
|
||||
delete
|
||||
Delete an OAuth client.
|
||||
|
||||
describe
|
||||
Describe an OAuth client.
|
||||
|
||||
list
|
||||
List OAuth clients.
|
||||
|
||||
undelete
|
||||
Undelete an OAuth client.
|
||||
|
||||
update
|
||||
Update an OAuth client.
|
||||
|
||||
NOTES
|
||||
This variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients
|
||||
|
||||
83
gcloud/iam/oauth-clients/list
Normal file
83
gcloud/iam/oauth-clients/list
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients list - list OAuth clients
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients list --location=LOCATION [--show-deleted]
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
List OAuth clients.
|
||||
|
||||
EXAMPLES
|
||||
The following command lists all OAuth clients in the default project,
|
||||
including the soft-deleted ones:
|
||||
|
||||
$ gcloud iam oauth-clients list --location="global" --show-deleted
|
||||
|
||||
REQUIRED FLAGS
|
||||
Location resource - The location you want to list OAuth clients for. This
|
||||
represents a Cloud resource. (NOTE) Some attributes are not given
|
||||
arguments in this group but can be set in other ways.
|
||||
|
||||
To set the project attribute:
|
||||
◆ provide the argument --location on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
--location=LOCATION
|
||||
ID of the location or fully qualified identifier for the location.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
FLAGS
|
||||
--show-deleted
|
||||
Whether to return soft-deleted OAuth clients.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients list
|
||||
|
||||
66
gcloud/iam/oauth-clients/undelete
Normal file
66
gcloud/iam/oauth-clients/undelete
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients undelete - undelete an OAuth client
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients undelete (OAUTH_CLIENT : --location=LOCATION)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Undelete an OAuth client.
|
||||
|
||||
EXAMPLES
|
||||
The following command undeletes the OAuth client with the ID
|
||||
my-oauth-client in the default project:
|
||||
|
||||
$ gcloud iam oauth-clients undelete my-oauth-client \
|
||||
--location="global"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client resource - The OAuth client to undelete. 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 project attribute:
|
||||
◆ provide the argument oauth_client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth_client attribute:
|
||||
▸ provide the argument oauth_client 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument oauth_client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients undelete
|
||||
|
||||
112
gcloud/iam/oauth-clients/update
Normal file
112
gcloud/iam/oauth-clients/update
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
NAME
|
||||
gcloud iam oauth-clients update - update an OAuth client
|
||||
|
||||
SYNOPSIS
|
||||
gcloud iam oauth-clients update (OAUTH_CLIENT : --location=LOCATION)
|
||||
[--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]]
|
||||
[--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]]
|
||||
[--allowed-scopes=[ALLOWED_SCOPES,...]] [--description=DESCRIPTION]
|
||||
[--disabled] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Update an OAuth Client.
|
||||
|
||||
EXAMPLES
|
||||
The following command updates the OAuth client with ID my-oauth-client in
|
||||
the default project:
|
||||
|
||||
$ gcloud iam oauth-clients update my-oauth-client \
|
||||
--location="global" --display-name="My oauth client" \
|
||||
--description="My oauth client description" --disabled \
|
||||
--allowed-grant-types="authorization-code-grant,refresh-token-gr\
|
||||
ant" \
|
||||
--allowed-scopes="https://www.googleapis.com/auth/cloud-platform\
|
||||
,openid" --allowed-redirect-uris="http://localhost/"
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Oauth client resource - The OAuth client 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 project attribute:
|
||||
◆ provide the argument oauth_client on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
OAUTH_CLIENT
|
||||
ID of the oauth client or fully qualified identifier for the oauth
|
||||
client.
|
||||
|
||||
To set the oauth_client attribute:
|
||||
▸ provide the argument oauth_client 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 name.
|
||||
|
||||
To set the location attribute:
|
||||
▸ provide the argument oauth_client on the command line with a
|
||||
fully specified name;
|
||||
▸ provide the argument --location on the command line.
|
||||
|
||||
FLAGS
|
||||
--allowed-grant-types=[ALLOWED_GRANT_TYPES,...]
|
||||
A list of OAuth grant types that are allowed for the OAuth client.
|
||||
|
||||
The following grant types are currently supported:
|
||||
|
||||
◆ authorization-code-grant
|
||||
|
||||
◆ refresh-token-grant
|
||||
|
||||
--allowed-redirect-uris=[ALLOWED_REDIRECT_URIS,...]
|
||||
A list of redirect uris that is allowed for redirecting when the
|
||||
authorization is completed.
|
||||
|
||||
--allowed-scopes=[ALLOWED_SCOPES,...]
|
||||
A list of scopes that the OAuth client is allowed to request during
|
||||
OAuth flows.
|
||||
|
||||
The following scopes are currently supported:
|
||||
|
||||
◆ https://www.googleapis.com/auth/cloud-platform: View, edit,
|
||||
configure, and delete your Google Cloud data, and view the email
|
||||
address for your Google Account.
|
||||
|
||||
◆ openid: Associate you with your personal info on Google Cloud.
|
||||
|
||||
◆ email: View your Google Cloud Account email address.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A description of the OAuth client. Cannot exceed 256 characters.
|
||||
|
||||
--disabled
|
||||
Disables the OAuth client. You cannot use a disabled OAuth client for
|
||||
login. Include --no-disabled to enable a disabled OAuth client.
|
||||
|
||||
--display-name=DISPLAY_NAME
|
||||
A display name for the OAuth client. Cannot exceed 32 characters.
|
||||
|
||||
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 variant is also available:
|
||||
|
||||
$ gcloud alpha iam oauth-clients update
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue