REST Resource: projects.locations.oauthClients.credentials

Resource: OauthClientCredential

Represents an OauthClientCredential. Used to authenticate an OauthClient while accessing Google Cloud resources on behalf of a user by using OAuth 2.0 Protocol.

JSON representation
{
  "name": string,
  "disabled": boolean,
  "displayName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "clientSecret": string
  // End of mutually exclusive fields.
}
Fields
name

string

Immutable. Identifier. The resource name of the OauthClientCredential.

Format: projects/{project}/locations/{location}/oauthClients/{oauthClient}/credentials/{credential}

disabled

boolean

Optional. Whether the OauthClientCredential is disabled. You cannot use a disabled OauthClientCredential.

displayName

string

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

Cannot exceed 32 characters.

The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
clientSecret

string

Output only. The system-generated OAuth client secret.

The client secret must be stored securely. If the client secret is leaked, you must delete and re-create the client credential. To learn more, see OAuth client and credential security risks and mitigations

End of mutually exclusive fields.

Methods

create

Creates a new OauthClientCredential.

delete

Deletes an OauthClientCredential.

get

Gets an individual OauthClientCredential.

list

Lists all OauthClientCredentials in an OauthClient.

patch

Updates an existing OauthClientCredential.