Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).

Enumerations

Properties

Functions

Properties

Optional fingerprint

fingerprint: undefined | string

The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional keyId

keyId: undefined | string

An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.

Optional keyValue

keyValue: undefined | string

The key's value.

Optional lifecycleState

lifecycleState: LifecycleState

The API key's current state. After creating an {@code ApiKey} object, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

Optional timeCreated

timeCreated: Date

Date and time the {@code ApiKey} object was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional userId

userId: undefined | string

The OCID of the user the key belongs to.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: ApiKey): object

getJsonObj

  • getJsonObj(obj: ApiKey): object