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.
-
#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
1374 1375 1376 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1374 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
1324 1325 1326 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1324 def key_algorithm @key_algorithm end |
#key_origin ⇒ String
The key origin.
Corresponds to the JSON property keyOrigin
1329 1330 1331 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1329 def key_origin @key_origin 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`
1335 1336 1337 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1335 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.
1347 1348 1349 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1347 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
1356 1357 1358 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1356 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.
1362 1363 1364 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1362 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
1367 1368 1369 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1367 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
1372 1373 1374 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1372 def valid_before_time @valid_before_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 |
# File 'generated/google/apis/iam_v1/classes.rb', line 1379 def update!(**args) @key_algorithm = args[:key_algorithm] if args.key?(:key_algorithm) @key_origin = args[:key_origin] if args.key?(:key_origin) @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 |