Class: Google::Apis::IamV1::ServiceAccountKey
- Inherits:
-
Object
- Object
- Google::Apis::IamV1::ServiceAccountKey
- 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 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. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys. Public keys for all service accounts are also published at the OAuth2 Service Account API.
Instance Attribute Summary collapse
-
#key_algorithm ⇒ String
Specifies the algorithm (and possibly key size) for the key.
-
#key_origin ⇒ String
The key origin.
-
#key_type ⇒ String
The key type.
-
#name ⇒ String
The resource name of the service account key in the following format
projects/
PROJECT_ID/serviceAccounts/
ACCOUNT/keys/
key``. -
#private_key_data ⇒ String
The private key data.
-
#private_key_type ⇒ String
The output format for the private key.
-
#public_key_data ⇒ String
The public key data.
-
#valid_after_time ⇒ String
The key can be used after this timestamp.
-
#valid_before_time ⇒ String
The key can be used before this timestamp.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ServiceAccountKey
constructor
A new instance of ServiceAccountKey.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ServiceAccountKey
Returns a new instance of ServiceAccountKey.
1428 1429 1430 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1428 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
1370 1371 1372 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1370 def key_algorithm @key_algorithm end |
#key_origin ⇒ String
The key origin.
Corresponds to the JSON property keyOrigin
1375 1376 1377 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1375 def key_origin @key_origin end |
#key_type ⇒ String
The key type.
Corresponds to the JSON property keyType
1380 1381 1382 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1380 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 property
name`
1386 1387 1388 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1386 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.
1398 1399 1400 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1398 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
1407 1408 1409 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1407 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.
1413 1414 1415 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1413 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
1418 1419 1420 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1418 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
1426 1427 1428 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1426 def valid_before_time @valid_before_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1433 def update!(**args) @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 |