Show / Hide Table of Contents

Class 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.

Inheritance
object
OauthClient
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Iam.v1.Data
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class OauthClient : IDirectResponseSchema

Properties

AllowedGrantTypes

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

Declaration
[JsonProperty("allowedGrantTypes")]
public virtual IList<string> AllowedGrantTypes { get; set; }
Property Value
Type Description
IList<string>

AllowedRedirectUris

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

Declaration
[JsonProperty("allowedRedirectUris")]
public virtual IList<string> AllowedRedirectUris { get; set; }
Property Value
Type Description
IList<string>

AllowedScopes

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. * openid: The OAuth client can associate you with your personal information 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.

Declaration
[JsonProperty("allowedScopes")]
public virtual IList<string> AllowedScopes { get; set; }
Property Value
Type Description
IList<string>

ClientId

Output only. The system-generated OauthClient id.

Declaration
[JsonProperty("clientId")]
public virtual string ClientId { get; set; }
Property Value
Type Description
string

ClientType

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

Declaration
[JsonProperty("clientType")]
public virtual string ClientType { get; set; }
Property Value
Type Description
string

Description

Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

Disabled

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

Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type Description
bool?

DisplayName

Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExpireTime

object representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ExpireTimeRaw

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

Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }
Property Value
Type Description
string

Name

Immutable. Identifier. The resource name of the OauthClient. Format:projects/{project}/locations/{location}/oauthClients/{oauth_client}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

State

Output only. The state of the OauthClient.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX