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 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.



1356
1357
1358
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1356

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) 


1302
1303
1304
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1302

def key_algorithm
  @key_algorithm
end

#key_origin ⇒ String

The key origin. Corresponds to the JSON property keyOrigin

Returns:

  • (String) 


1307
1308
1309
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1307

def key_origin
  @key_origin
end

#key_type ⇒ String

The key type. Corresponds to the JSON property keyType

Returns:

  • (String) 


1312
1313
1314
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1312

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) 


1318
1319
1320
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1318

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) 


1328
1329
1330
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1328

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) 


1336
1337
1338
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1336

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) 


1342
1343
1344
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1342

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) 


1347
1348
1349
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1347

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) 


1354
1355
1356
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1354

def valid_before_time
  @valid_before_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'generated/google/apis/iam_v1/classes.rb', line 1361

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