Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CustomerSecretKey

A {@code CustomerSecretKey} is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API. The key consists of a secret key/access key pair. A user can have up to two secret keys at a time.

*Note:** The secret key is always an Oracle-generated string; you can't change it to a string of your choice.

For more information, see [Managing User Credentials](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).

Enumerations

Properties

Functions

Properties

Optional displayName

displayName: undefined | string

The display name you assign to the secret key. Does not have to be unique, and it's changeable.

Optional id

id: undefined | string

The access key portion of the key pair.

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 key

key: undefined | string

The secret key.

Optional lifecycleState

lifecycleState: LifecycleState

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

Optional timeCreated

timeCreated: Date

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

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

Optional timeExpires

timeExpires: Date

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

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

Optional userId

userId: undefined | string

The OCID of the user the password belongs to.

Functions

getDeserializedJsonObj

getJsonObj