Show / Hide Table of Contents

Class ApiKeyItem

The ApiKey item.

Inheritance
object
ApiKeyItem
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiService.Models
Assembly: OCI.DotNetSDK.Generativeai.dll
Syntax
public class ApiKeyItem

Properties

Key

Declaration
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

The key.

KeyMask

Declaration
[Required(ErrorMessage = "KeyMask is required.")]
[JsonProperty(PropertyName = "keyMask")]
public string KeyMask { get; set; }
Property Value
Type Description
string

The masked key.

Remarks

Required

KeyName

Declaration
[Required(ErrorMessage = "KeyName is required.")]
[JsonProperty(PropertyName = "keyName")]
public string KeyName { get; set; }
Property Value
Type Description
string

The key name.

Remarks

Required

State

Declaration
[Required(ErrorMessage = "State is required.")]
[JsonProperty(PropertyName = "state")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ApiKeyItem.StateEnum? State { get; set; }
Property Value
Type Description
ApiKeyItem.StateEnum?

The current state of the API key item.

Remarks

Required

TimeActivated

Declaration
[JsonProperty(PropertyName = "timeActivated")]
public DateTime? TimeActivated { get; set; }
Property Value
Type Description
DateTime?

The date and time that the key is activated in the format of an RFC3339 datetime string.

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time that the key was created in the format of an RFC3339 datetime string.

Remarks

Required

TimeDeactivated

Declaration
[JsonProperty(PropertyName = "timeDeactivated")]
public DateTime? TimeDeactivated { get; set; }
Property Value
Type Description
DateTime?

The date and time that the key is deactivated in the format of an RFC3339 datetime string.

TimeExpiry

Declaration
[Required(ErrorMessage = "TimeExpiry is required.")]
[JsonProperty(PropertyName = "timeExpiry")]
public DateTime? TimeExpiry { get; set; }
Property Value
Type Description
DateTime?

The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.

Remarks

Required

TimeLastUsed

Declaration
[JsonProperty(PropertyName = "timeLastUsed")]
public DateTime? TimeLastUsed { get; set; }
Property Value
Type Description
DateTime?

The date and time that the key is last used in the format of an RFC3339 datetime string.

TimeRevoked

Declaration
[JsonProperty(PropertyName = "timeRevoked")]
public DateTime? TimeRevoked { get; set; }
Property Value
Type Description
DateTime?

The date and time that the key is revoked in the format of an RFC3339 datetime string.

In this article
Back to top