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

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

Overview

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 util::Status's ResourceInfo.resource_name in the format of projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_EMAIL. 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/SERVICE_ACCOUNT_EMAIL`. Using-as a wildcard for the project will infer the project from the account. Theaccountvalue can be theemailaddress or the unique_id` of the service account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ServiceAccount

Returns a new instance of ServiceAccount



375
376
377
 
# File 'generated/google/apis/iam_v1/classes.rb', line 375

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

Instance Attribute Details

#display_name ⇒ String

Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


351
352
353
 
# File 'generated/google/apis/iam_v1/classes.rb', line 351

def display_name
  @display_name
end

#email ⇒ String

Corresponds to the JSON property email

Returns:

  • (String) 


373
374
375
 
# File 'generated/google/apis/iam_v1/classes.rb', line 373

def email
  @email
end

#etag ⇒ String

Used to perform a consistent read-modify-write. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


357
358
359
 
# File 'generated/google/apis/iam_v1/classes.rb', line 357

def etag
  @etag
end

#name ⇒ String

The resource name of the service account in the following format: projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_EMAIL. Requests using `-` as a wildcard for the project 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/`SERVICE_ACCOUNT_EMAIL. Corresponds to the JSON property name

Returns:

  • (String) 


368
369
370
 
# File 'generated/google/apis/iam_v1/classes.rb', line 368

def name
  @name
end

#oauth2_client_id ⇒ String

This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users. Corresponds to the JSON property oauth2ClientId

Returns:

  • (String) 


340
341
342
 
# File 'generated/google/apis/iam_v1/classes.rb', line 340

def oauth2_client_id
  @oauth2_client_id
end

#project_id ⇒ String

Corresponds to the JSON property projectId

Returns:

  • (String) 


333
334
335
 
# File 'generated/google/apis/iam_v1/classes.rb', line 333

def project_id
  @project_id
end

#unique_id ⇒ String

Corresponds to the JSON property uniqueId

Returns:

  • (String) 


345
346
347
 
# File 'generated/google/apis/iam_v1/classes.rb', line 345

def unique_id
  @unique_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



380
381
382
383
384
385
386
387
388
 
# File 'generated/google/apis/iam_v1/classes.rb', line 380

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