Class: Google::Apis::IamV1::ServiceAccount

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/iam_v1/classes.rb,
lib/google/apis/iam_v1/representations.rb,
lib/google/apis/iam_v1/representations.rb

Overview

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 //

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ServiceAccount

Returns a new instance of ServiceAccount.



1793
1794
1795
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1793

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes. Corresponds to the JSON property description

Returns:

  • (String) 


1735
1736
1737
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1735

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

Output only. Whether the service account is disabled. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1740
1741
1742
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1740

def disabled
  @disabled
end

#display_name ⇒ String

Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


1747
1748
1749
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1747

def display_name
  @display_name
end

#email ⇒ String

Output only. The email address of the service account. Corresponds to the JSON property email

Returns:

  • (String) 


1752
1753
1754
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1752

def email
  @email
end

#etag ⇒ String

Deprecated. Do not use. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1758
1759
1760
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1758

def etag
  @etag
end

#name ⇒ String

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 access 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. Corresponds to the JSON property name

Returns:

  • (String) 


1772
1773
1774
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1772

def name
  @name
end

#oauth2_client_id ⇒ String

Output only. The OAuth 2.0 client ID for the service account. Corresponds to the JSON property oauth2ClientId

Returns:

  • (String) 


1777
1778
1779
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1777

def oauth2_client_id
  @oauth2_client_id
end

#project_id ⇒ String

Output only. The ID of the project that owns the service account. Corresponds to the JSON property projectId

Returns:

  • (String) 


1782
1783
1784
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1782

def project_id
  @project_id
end

#unique_id ⇒ String

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. Corresponds to the JSON property uniqueId

Returns:

  • (String) 


1791
1792
1793
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1791

def unique_id
  @unique_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1798

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id)
  @project_id = args[:project_id] if args.key?(:project_id)
  @unique_id = args[:unique_id] if args.key?(:unique_id)
end