Difference between revisions of "Gcloud auth --help"
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{lc}} | {{lc}} | ||
| − | + | [[gcloud auth]] --help | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | DESCRIPTION | + | NAME |
| − | + | gcloud auth - manage oauth2 credentials for the Google Cloud CLI | |
| − | + | ||
| − | + | SYNOPSIS | |
| − | + | gcloud auth GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] | |
| − | + | ||
| − | + | DESCRIPTION | |
| − | + | The gcloud auth command group lets you grant and revoke authorization to | |
| − | + | Google Cloud CLI (gcloud CLI) to access Google Cloud. Typically, when | |
| − | + | scripting Google Cloud CLI tools for use on multiple machines, using gcloud | |
| − | + | auth activate-service-account is recommended. | |
| − | + | ||
| − | + | For information about authorization and credential types, see Authorizing | |
| + | the gcloud CLI (https://cloud.google.com/sdk/docs/authorizing). For | ||
| + | information about authorizing a service account, see Authorizing with a | ||
| + | service account | ||
| + | (https://cloud.google.com/sdk/docs/authorizing#authorizing_with_a_service_account). | ||
| + | |||
| + | After running gcloud auth commands, you can run other commands with | ||
--account=ACCOUNT to authenticate the command with the credentials of the | --account=ACCOUNT to authenticate the command with the credentials of the | ||
specified account. For information about --account and other gcloud CLI | specified account. For information about --account and other gcloud CLI | ||
global flags, see the gcloud CLI overview | global flags, see the gcloud CLI overview | ||
(https://cloud.google.com/sdk/gcloud/reference). | (https://cloud.google.com/sdk/gcloud/reference). | ||
| − | + | ||
| − | EXAMPLES | + | EXAMPLES |
To authenticate a user account with gcloud and minimal user output, run: | To authenticate a user account with gcloud and minimal user output, run: | ||
| Line 39: | Line 41: | ||
$ gcloud auth revoke [email protected] | $ gcloud auth revoke [email protected] | ||
| − | + | ||
| − | GCLOUD WIDE FLAGS | + | GCLOUD WIDE FLAGS |
These flags are available to all commands: --help. | These flags are available to all commands: --help. | ||
Run $ gcloud help for details. | Run $ gcloud help for details. | ||
| − | + | ||
| − | GROUPS | + | GROUPS |
GROUP is one of the following: | GROUP is one of the following: | ||
application-default | application-default | ||
Manage your active Application Default Credentials. | Manage your active Application Default Credentials. | ||
| − | + | ||
| − | COMMANDS | + | COMMANDS |
COMMAND is one of the following: | COMMAND is one of the following: | ||
| Line 57: | Line 59: | ||
Authorize access to Google Cloud with a service account. | Authorize access to Google Cloud with a service account. | ||
| − | configure-docker | + | [[configure-docker]] |
| − | Register gcloud as a Docker credential helper. | + | Register gcloud as a Docker [[credential helper]]. |
list | list | ||
| Line 75: | Line 77: | ||
revoke | revoke | ||
Revoke access credentials for an account. | Revoke access credentials for an account. | ||
| − | |||
== See also == | == See also == | ||
| − | * {{gcloud}} | + | * {{gcloud auth}} |
[[Category:gcloud]] | [[Category:gcloud]] | ||
| + | [[Category:GCP]] | ||
Latest revision as of 11:04, 22 June 2022
gcloud auth --help
NAME
gcloud auth - manage oauth2 credentials for the Google Cloud CLI
SYNOPSIS
gcloud auth GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
The gcloud auth command group lets you grant and revoke authorization to
Google Cloud CLI (gcloud CLI) to access Google Cloud. Typically, when
scripting Google Cloud CLI tools for use on multiple machines, using gcloud
auth activate-service-account is recommended.
For information about authorization and credential types, see Authorizing
the gcloud CLI (https://cloud.google.com/sdk/docs/authorizing). For
information about authorizing a service account, see Authorizing with a
service account
(https://cloud.google.com/sdk/docs/authorizing#authorizing_with_a_service_account).
After running gcloud auth commands, you can run other commands with
--account=ACCOUNT to authenticate the command with the credentials of the
specified account. For information about --account and other gcloud CLI
global flags, see the gcloud CLI overview
(https://cloud.google.com/sdk/gcloud/reference).
EXAMPLES
To authenticate a user account with gcloud and minimal user output, run:
$ gcloud auth login --brief
To list all credentialed accounts and identify the current active account, run:
$ gcloud auth list
To revoke credentials for a user account (like logging out), run:
$ gcloud auth revoke [email protected] GCLOUD WIDE FLAGS These flags are available to all commands: --help.
Run $ gcloud help for details. GROUPS GROUP is one of the following:
application-default
Manage your active Application Default Credentials.
COMMANDS
COMMAND is one of the following:
activate-service-account
Authorize access to Google Cloud with a service account.
configure-docker Register gcloud as a Docker credential helper.
list
Lists credentialed accounts.
login
Authorize gcloud to access the Cloud Platform with Google user
credentials.
print-access-token
Print an access token for the specified account.
print-identity-token
Print an identity token for the specified account.
revoke
Revoke access credentials for an account.
See also[edit]
Advertising:
