google_api_iam v0.4.0 GoogleApi.IAM.V1.Model.ServiceAccountKey View Source
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.
Attributes
keyAlgorithm (String.t): Specifies the algorithm (and possibly key size) for the key. Defaults to:
null
.- Enum - one of [KEY_ALG_UNSPECIFIED, KEY_ALG_RSA_1024, KEY_ALG_RSA_2048]
- name (String.t): The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. Defaults to:
null
. - privateKeyData (binary()): 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 <a href="/sdk/gcloud/reference/auth/activate-service-account">gcloud auth activate-service-account</a>. Defaults to:
null
. privateKeyType (String.t): 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. Defaults to:
null
.- Enum - one of [TYPE_UNSPECIFIED, TYPE_PKCS12_FILE, TYPE_GOOGLE_CREDENTIALS_FILE]
- publicKeyData (binary()): The public key data. Only provided in `GetServiceAccountKey` responses. Defaults to:
null
. - validAfterTime (DateTime.t): The key can be used after this timestamp. Defaults to:
null
. - validBeforeTime (DateTime.t): The key can be used before this timestamp. Defaults to:
null
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.IAM.V1.Model.ServiceAccountKey{
keyAlgorithm: any(),
name: any(),
privateKeyData: any(),
privateKeyType: any(),
publicKeyData: any(),
validAfterTime: DateTime.t(),
validBeforeTime: DateTime.t()
}
t() :: %GoogleApi.IAM.V1.Model.ServiceAccountKey{ keyAlgorithm: any(), name: any(), privateKeyData: any(), privateKeyType: any(), publicKeyData: any(), validAfterTime: DateTime.t(), validBeforeTime: DateTime.t() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.