Class ApiKey
A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known
as an API signing key. Specifically, this is the public key from the key pair. The private key remains with
the user calling the API. For information about generating a key pair
in the required PEM format, see Required Keys and OCIDs.
Important: This is not the SSH key for accessing compute instances.
Each user can have a maximum of three API signing keys.
For more information about user credentials, see User Credentials.
Inherited Members
Namespace: Oci.IdentityService.Models
Assembly: OCI.DotNetSDK.Identity.dll
Syntax
public class ApiKey
Properties
Fingerprint
Declaration
[JsonProperty(PropertyName = "fingerprint")]
public string Fingerprint { get; set; }
Property Value
Type | Description |
---|---|
string | The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef). |
InactiveStatus
Declaration
[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }
Property Value
Type | Description |
---|---|
long? | The detailed status of INACTIVE lifecycleState. |
KeyId
Declaration
[JsonProperty(PropertyName = "keyId")]
public string KeyId { get; set; }
Property Value
Type | Description |
---|---|
string | An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT. |
KeyValue
Declaration
[JsonProperty(PropertyName = "keyValue")]
public string KeyValue { get; set; }
Property Value
Type | Description |
---|---|
string | The key's value. |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ApiKey.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ApiKey.LifecycleStateEnum? | The API key's current state. After creating an |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time the |
UserId
Declaration
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the user the key belongs to. |