mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-11 23:49:35 +00:00
118 lines
4.4 KiB
Text
118 lines
4.4 KiB
Text
NAME
|
|
gcloud alpha iam oauth-clients update - update an OAuth client
|
|
|
|
SYNOPSIS
|
|
gcloud alpha 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
|
|
(ALPHA) Update an OAuth Client.
|
|
|
|
EXAMPLES
|
|
The following command updates the OAuth client with ID my-oauth-client in
|
|
the default project:
|
|
|
|
$ gcloud alpha 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: The OAuth client can read a federated identity's email
|
|
address.
|
|
|
|
◆ groups: The OAuth client can read a federated identity's groups.
|
|
|
|
--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 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. This variant is also available:
|
|
|
|
$ gcloud iam oauth-clients update
|
|
|