google_api_iam v0.15.0 GoogleApi.IAM.V1.Model.ServiceAccount View Source

A service account in the Identity and Access Management API.

To create a service account, specify the project_id and the account_id for the account. The account_id is unique within the project, and is used to generate the service account email address and a stable unique_id.

If the account already exists, the account's resource name is returned in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can use the name in other methods to access the account.

All other methods can identify the service account using the format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. Using - as a wildcard for the PROJECT_ID will infer the project from the account. The ACCOUNT value can be the email address or the unique_id of the service account.

Attributes

  • description (type: String.t, default: nil) - Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

  • disabled (type: boolean(), default: nil) - @OutputOnly A bool indicate if the service account is disabled. The field is currently in alpha phase.

  • displayName (type: String.t, default: nil) - Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.

  • email (type: String.t, default: nil) - @OutputOnly The email address of the service account.

  • etag (type: String.t, default: nil) - Optional. Note: etag is an inoperable legacy field that is only returned for backwards compatibility.

  • name (type: String.t, default: nil) - The resource name of the service account in the following format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

    Requests using - as a wildcard for the PROJECT_ID will infer the project from the account and the ACCOUNT value can be the email address or the unique_id of the service account.

    In responses the resource name will always be in the format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}.

  • oauth2ClientId (type: String.t, default: nil) - @OutputOnly The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.

  • projectId (type: String.t, default: nil) - @OutputOnly The id of the project that owns the service account.

  • uniqueId (type: String.t, default: nil) - @OutputOnly The unique and stable id of the service account.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

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

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.