REST Resource: projects.locations.oauthClients

Resource: OauthClient

Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "disabled": boolean,
  "clientId": string,
  "displayName": string,
  "description": string,
  "clientType": enum (ClientType),
  "allowedGrantTypes": [
    enum (GrantType)
  ],
  "allowedScopes": [
    string
  ],
  "allowedRedirectUris": [
    string
  ],
  "expireTime": string
}
Fields
name

string

Immutable. Identifier. The resource name of the OauthClient.

Format:projects/{project}/locations/{location}/oauthClients/{oauthClient}.
state

enum (State)

Output only. The state of the OauthClient.
disabled

boolean

Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
clientId

string

Output only. The system-generated OauthClient id.
displayName

string

Optional. A user-specified display name of the OauthClient.

Cannot exceed 32 characters.
description

string

Optional. A user-specified description of the OauthClient.

Cannot exceed 256 characters.
clientType

enum (ClientType)

Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
allowedGrantTypes[]

enum (GrantType)

Required. The list of OAuth grant types is allowed for the OauthClient.
allowedScopes[]

string

Required. The list of scopes that the OauthClient is allowed to request during OAuth flows.

The following scopes are supported:

  • https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
allowedRedirectUris[]

string

Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
expireTime

string (Timestamp format)

Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

The current state of the OauthClient.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
ACTIVE The OauthClient is active.
DELETED The OauthClient is soft-deleted. Soft-deleted OauthClient is permanently deleted after approximately 30 days unless restored via oauthClients.undelete.

ClientType

The type of OauthClient.

Enums
CLIENT_TYPE_UNSPECIFIED Should not be used.
PUBLIC_CLIENT Public client has no secret.
CONFIDENTIAL_CLIENT Private client.

GrantType

The OAuth grant type.

Enums
GRANT_TYPE_UNSPECIFIED Should not be used.
AUTHORIZATION_CODE_GRANT Authorization code grant.
REFRESH_TOKEN_GRANT Refresh token grant.

Methods

create

 The method google.iam.admin.v1.OauthClients.CreateOauthClient is not available in this (s3nsapis.fr) universe.

delete

 The method google.iam.admin.v1.OauthClients.DeleteOauthClient is not available in this (s3nsapis.fr) universe.

get

 The method google.iam.admin.v1.OauthClients.GetOauthClient is not available in this (s3nsapis.fr) universe.

list

 The method google.iam.admin.v1.OauthClients.ListOauthClients is not available in this (s3nsapis.fr) universe.

patch

 The method google.iam.admin.v1.OauthClients.UpdateOauthClient is not available in this (s3nsapis.fr) universe.

undelete

 The method google.iam.admin.v1.OauthClients.UndeleteOauthClient is not available in this (s3nsapis.fr) universe.