google_api_iam v0.37.3

View Source GoogleApi.IAM.V1.Model.ServiceAccount (google_api_iam v0.37.3)

An IAM service account. A service account is an account for an application or a virtual machine (VM) instance, not a person. You can use a service account to call Google APIs. To learn more, read the overview of service accounts. When you create a service account, you specify the project ID that owns the service account, as well as a name that must be unique within the project. IAM uses these values to create an email address that identifies the service account.

Attributes

  • description (type: String.t, default: nil) - Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.
  • disabled (type: boolean(), default: nil) - Output only. Whether the service account is disabled.
  • displayName (type: String.t, default: nil) - Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.
  • email (type: String.t, default: nil) - Output only. The email address of the service account.
  • etag (type: String.t, default: nil) - Deprecated. Do not use.
  • name (type: String.t, default: nil) - The resource name of the service account. Use one of the following formats: projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS} projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID} As an alternative, you can use the - wildcard character instead of the project ID: projects/-/serviceAccounts/{EMAIL_ADDRESS} projects/-/serviceAccounts/{UNIQUE_ID} When possible, avoid using the - wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to get the service account projects/-/serviceAccounts/fake@example.com, which does not exist, the response contains an HTTP 403 Forbidden error instead of a 404 Not Found error.
  • oauth2ClientId (type: String.t, default: nil) - Output only. The OAuth 2.0 client ID for the service account.
  • projectId (type: String.t, default: nil) - Output only. The ID of the project that owns the service account.
  • uniqueId (type: String.t, default: nil) - Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %GoogleApi.IAM.V1.Model.ServiceAccount{
  description: String.t() | nil,
  disabled: boolean() | nil,
  displayName: String.t() | nil,
  email: String.t() | nil,
  etag: String.t() | nil,
  name: String.t() | nil,
  oauth2ClientId: String.t() | nil,
  projectId: String.t() | nil,
  uniqueId: String.t() | nil
}

Link to this section Functions

Link to this function

decode(value, options)

View Source

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.