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 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
-
#key_algorithm ⇒ String
Specifies the algorithm (and possibly key size) for the key.
-
#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
977 978 979 |
# File 'generated/google/apis/iam_v1/classes.rb', line 977 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
932 933 934 |
# File 'generated/google/apis/iam_v1/classes.rb', line 932 def key_algorithm @key_algorithm 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`
938 939 940 |
# File 'generated/google/apis/iam_v1/classes.rb', line 938 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.
950 951 952 |
# File 'generated/google/apis/iam_v1/classes.rb', line 950 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
959 960 961 |
# File 'generated/google/apis/iam_v1/classes.rb', line 959 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.
965 966 967 |
# File 'generated/google/apis/iam_v1/classes.rb', line 965 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
970 971 972 |
# File 'generated/google/apis/iam_v1/classes.rb', line 970 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
975 976 977 |
# File 'generated/google/apis/iam_v1/classes.rb', line 975 def valid_before_time @valid_before_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
982 983 984 985 986 987 988 989 990 |
# File 'generated/google/apis/iam_v1/classes.rb', line 982 def update!(**args) @key_algorithm = args[:key_algorithm] if args.key?(:key_algorithm) @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 |