GoogleApi.IAM.V1.Model.OauthClient (google_api_iam v0.45.0)

View Source

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.

Attributes

  • allowedGrantTypes (type: list(String.t), default: nil) - Required. The list of OAuth grant types is allowed for the OauthClient.
  • allowedRedirectUris (type: list(String.t), default: nil) - Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
  • allowedScopes (type: list(String.t), default: nil) - 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.
  • clientId (type: String.t, default: nil) - Output only. The system-generated OauthClient id.
  • clientType (type: String.t, default: nil) - Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
  • description (type: String.t, default: nil) - Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
  • disabled (type: boolean(), default: nil) - Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
  • displayName (type: String.t, default: nil) - Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
  • expireTime (type: DateTime.t, default: nil) - Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
  • name (type: String.t, default: nil) - Immutable. Identifier. The resource name of the OauthClient. Format:projects/{project}/locations/{location}/oauthClients/{oauth_client}.
  • state (type: String.t, default: nil) - Output only. The state of the OauthClient.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.IAM.V1.Model.OauthClient{
  allowedGrantTypes: [String.t()] | nil,
  allowedRedirectUris: [String.t()] | nil,
  allowedScopes: [String.t()] | nil,
  clientId: String.t() | nil,
  clientType: String.t() | nil,
  description: String.t() | nil,
  disabled: boolean() | nil,
  displayName: String.t() | nil,
  expireTime: DateTime.t() | nil,
  name: String.t() | nil,
  state: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.