gcloud alpha iam oauth-clients create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha iam oauth-clients create - create an OAuth client
- SYNOPSIS
gcloud alpha 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
(ALPHA)Create a new OAuth client.- EXAMPLES
- The following command creates a disabled OAuth client with ID
in the default project:my-oauth-clientgcloudalphaiamoauth-clientscreatemy-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-grant"--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 groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
oauth_clienton the command line with a fullyspecified name; - provide the argument
--projecton 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_clientattribute:- provide the argument
oauth_clienton the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The location name.
To set the
locationattribute:- provide the argument
oauth_clienton the command line with a fullyspecified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Oauth client resource - The OAuth client to create. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.
- 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 authorizationis 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 foryour Google Account.
openid: Associate you with your personal info on Google Cloud.
email: The OAuth client can read a federated identity's emailaddress.
groups: The OAuth client can read a federated identity's groups.
--client-type=CLIENT_TYPE- The type of OAuth client.
CLIENT_TYPEmust 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-disabledto 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 helpfor details. - API REFERENCE
- This command uses the
iam/v1API. The full documentation for thisAPI can be found at:https://cloud.google.com/iam/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudiamoauth-clientscreate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.