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

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

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 keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ServiceAccountKey

Returns a new instance of ServiceAccountKey.



1531
1532
1533
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1531

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

Instance Attribute Details

#disabled ⇒ Boolean Also known as: disabled?

The key status. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1471
1472
1473
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1471

def disabled
  @disabled
end

#key_algorithm ⇒ String

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

Returns:

  • (String) 


1477
1478
1479
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1477

def key_algorithm
  @key_algorithm
end

#key_origin ⇒ String

The key origin. Corresponds to the JSON property keyOrigin

Returns:

  • (String) 


1482
1483
1484
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1482

def key_origin
  @key_origin
end

#key_type ⇒ String

The key type. Corresponds to the JSON property keyType

Returns:

  • (String) 


1487
1488
1489
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1487

def key_type
  @key_type
end

#name ⇒ String

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

Returns:

  • (String) 


1493
1494
1495
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1493

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. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account. Corresponds to the JSON property privateKeyData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1503
1504
1505
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1503

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) 


1511
1512
1513
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1511

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) 


1517
1518
1519
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1517

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) 


1522
1523
1524
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1522

def valid_after_time
  @valid_after_time
end

#valid_before_time ⇒ String

The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time. Corresponds to the JSON property validBeforeTime

Returns:

  • (String) 


1529
1530
1531
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1529

def valid_before_time
  @valid_before_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/google/apis/iam_v1/classes.rb', line 1536

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