Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KmsManagementClient

Hierarchy

  • KmsManagementClient

Constructors

constructor

Properties

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://kms.{region}.{secondLevelDomain}"

Accessors

endpoint

  • set endpoint(endpoint: string): void

Methods

backupKey

  • Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<BackupKeyResponse>

    BackupKeyResponse

cancelKeyDeletion

  • Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key's lifecycle state to what it was before its scheduled deletion.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CancelKeyDeletionResponse>

    CancelKeyDeletionResponse

cancelKeyVersionDeletion

  • Cancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CancelKeyVersionDeletionResponse>

    CancelKeyVersionDeletionResponse

changeKeyCompartment

  • Moves a key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

    When provided, if-match is checked against the ETag values of the key.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ChangeKeyCompartmentResponse>

    ChangeKeyCompartmentResponse

createKey

  • Creates a new master encryption key.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CreateKeyResponse>

    CreateKeyResponse

createKeyVersion

  • Generates a new KeyVersion resource that provides new cryptographic material for a master encryption key. The key must be in an ENABLED state to be rotated.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<CreateKeyVersionResponse>

    CreateKeyVersionResponse

createWaiters

disableKey

  • Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<DisableKeyResponse>

    DisableKeyResponse

enableKey

  • Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<EnableKeyResponse>

    EnableKeyResponse

getKey

  • Gets information about the specified master encryption key.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<GetKeyResponse>

    GetKeyResponse

getKeyVersion

  • Gets information about the specified key version.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<GetKeyVersionResponse>

    GetKeyVersionResponse

getWaiters

getWrappingKey

importKey

  • Imports AES key material to create a new key with. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ImportKeyResponse>

    ImportKeyResponse

importKeyVersion

  • Imports AES key material to create a new key version with, and then rotates the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ImportKeyVersionResponse>

    ImportKeyVersionResponse

listAllKeyVersions

  • Creates a new async iterator which will iterate over the models.KeyVersionSummary objects contained in responses from the listKeyVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<KeyVersionSummary>

listAllKeyVersionsResponses

listAllKeys

  • Creates a new async iterator which will iterate over the models.KeySummary objects contained in responses from the listKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListKeysRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<KeySummary>

listAllKeysResponses

  • Creates a new async iterator which will iterate over the responses received from the listKeys operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListKeysRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListKeysResponse>

listKeyVersions

  • Lists all KeyVersion resources for the specified master encryption key.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ListKeyVersionsResponse>

    ListKeyVersionsResponse

listKeys

  • Lists the master encryption keys in the specified vault and compartment.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ListKeysResponse>

    ListKeysResponse

restoreKeyFromFile

  • Restores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<RestoreKeyFromFileResponse>

    RestoreKeyFromFileResponse

restoreKeyFromObjectStore

  • Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<RestoreKeyFromObjectStoreResponse>

    RestoreKeyFromObjectStoreResponse

scheduleKeyDeletion

  • Schedules the deletion of the specified key. This sets the lifecycle state of the key to PENDING_DELETION and then deletes it after the specified retention period ends.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ScheduleKeyDeletionResponse>

    ScheduleKeyDeletionResponse

scheduleKeyVersionDeletion

  • Schedules the deletion of the specified key version. This sets the lifecycle state of the key version to PENDING_DELETION and then deletes it after the specified retention period ends.

    As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<ScheduleKeyVersionDeletionResponse>

    ScheduleKeyVersionDeletionResponse

updateKey

  • Updates the properties of a master encryption key. Specifically, you can update the displayName, freeformTags, and definedTags properties. Furthermore, the key must in an ENABLED or CREATING state to be updated.

    As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

    throws

    OciError when an error occurs

    Parameters

    Returns Promise<UpdateKeyResponse>

    UpdateKeyResponse