Class: Google::Apis::IamV1::ServiceAccountKey

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

Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.

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) ⇒ ServiceAccountKey

Returns a new instance of ServiceAccountKey



489
490
491
 
# File 'generated/google/apis/iam_v1/classes.rb', line 489

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

Instance Attribute Details

#key_algorithm ⇒ String

Specifies the algorithm (and possibly key size) for the key. Corresponds to the JSON property keyAlgorithm

Returns:

  • (String) 


465
466
467
 
# File 'generated/google/apis/iam_v1/classes.rb', line 465

def key_algorithm
  @key_algorithm
end

#name ⇒ String

The resource name of the service account key in the following format projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_EMAIL/keys/key`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


455
456
457
 
# File 'generated/google/apis/iam_v1/classes.rb', line 455

def name
  @name
end

#private_key_data ⇒ String

The private key data. Only provided in CreateServiceAccountKey responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. Corresponds to the JSON property privateKeyData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


487
488
489
 
# File 'generated/google/apis/iam_v1/classes.rb', line 487

def private_key_data
  @private_key_data
end

#private_key_type ⇒ String

The output format for the private key. Only provided in CreateServiceAccountKey responses, not in GetServiceAccountKey or ListServiceAccountKey responses. Google never exposes system-managed private keys, and never retains user-managed private keys. Corresponds to the JSON property privateKeyType

Returns:

  • (String) 


479
480
481
 
# File 'generated/google/apis/iam_v1/classes.rb', line 479

def private_key_type
  @private_key_type
end

#public_key_data ⇒ String

The public key data. Only provided in GetServiceAccountKey responses. Corresponds to the JSON property publicKeyData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


449
450
451
 
# File 'generated/google/apis/iam_v1/classes.rb', line 449

def public_key_data
  @public_key_data
end

#valid_after_time ⇒ String

The key can be used after this timestamp. Corresponds to the JSON property validAfterTime

Returns:

  • (String) 


470
471
472
 
# File 'generated/google/apis/iam_v1/classes.rb', line 470

def valid_after_time
  @valid_after_time
end

#valid_before_time ⇒ String

The key can be used before this timestamp. Corresponds to the JSON property validBeforeTime

Returns:

  • (String) 


460
461
462
 
# File 'generated/google/apis/iam_v1/classes.rb', line 460

def valid_before_time
  @valid_before_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



494
495
496
497
498
499
500
501
502
 
# File 'generated/google/apis/iam_v1/classes.rb', line 494

def update!(**args)
  @public_key_data = args[:public_key_data] if args.key?(:public_key_data)
  @name = args[:name] if args.key?(:name)
  @valid_before_time = args[:valid_before_time] if args.key?(:valid_before_time)
  @key_algorithm = args[:key_algorithm] if args.key?(:key_algorithm)
  @valid_after_time = args[:valid_after_time] if args.key?(:valid_after_time)
  @private_key_type = args[:private_key_type] if args.key?(:private_key_type)
  @private_key_data = args[:private_key_data] if args.key?(:private_key_data)
end