Class ServiceAccountKey

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.

Inheritance
object
ServiceAccountKey
Implements
Inherited Members
Namespace: Google.Apis.Iam.v1.Data
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class ServiceAccountKey : IDirectResponseSchema

Properties

DisableReason

Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.

Declaration
[JsonProperty("disableReason")]
public virtual string DisableReason { get; set; }
Property Value
Type Description
string

Disabled

The key status.

Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExtendedStatus

Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.

Declaration
[JsonProperty("extendedStatus")]
public virtual IList<ExtendedStatus> ExtendedStatus { get; set; }
Property Value
Type Description
IList<ExtendedStatus>

KeyAlgorithm

Specifies the algorithm (and possibly key size) for the key.

Declaration
[JsonProperty("keyAlgorithm")]
public virtual string KeyAlgorithm { get; set; }
Property Value
Type Description
string

KeyOrigin

The key origin.

Declaration
[JsonProperty("keyOrigin")]
public virtual string KeyOrigin { get; set; }
Property Value
Type Description
string

KeyType

The key type.

Declaration
[JsonProperty("keyType")]
public virtual string KeyType { get; set; }
Property Value
Type Description
string

Name

The resource name of the service account key in the following format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PrivateKeyData

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.

Declaration
[JsonProperty("privateKeyData")]
public virtual string PrivateKeyData { get; set; }
Property Value
Type Description
string

PrivateKeyType

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.

Declaration
[JsonProperty("privateKeyType")]
public virtual string PrivateKeyType { get; set; }
Property Value
Type Description
string

PublicKeyData

The public key data. Only provided in GetServiceAccountKey responses.

Declaration
[JsonProperty("publicKeyData")]
public virtual string PublicKeyData { get; set; }
Property Value
Type Description
string

ValidAfterTime

object representation of ValidAfterTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ValidAfterTimeDateTimeOffset instead.")]
public virtual object ValidAfterTime { get; set; }
Property Value
Type Description
object

ValidAfterTimeDateTimeOffset

DateTimeOffset representation of ValidAfterTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ValidAfterTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ValidAfterTimeRaw

The key can be used after this timestamp.

Declaration
[JsonProperty("validAfterTime")]
public virtual string ValidAfterTimeRaw { get; set; }
Property Value
Type Description
string

ValidBeforeTime

object representation of ValidBeforeTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ValidBeforeTimeDateTimeOffset instead.")]
public virtual object ValidBeforeTime { get; set; }
Property Value
Type Description
object

ValidBeforeTimeDateTimeOffset

DateTimeOffset representation of ValidBeforeTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ValidBeforeTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ValidBeforeTimeRaw

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.

Declaration
[JsonProperty("validBeforeTime")]
public virtual string ValidBeforeTimeRaw { get; set; }
Property Value
Type Description
string

Implements