Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VaultsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • VaultsClient

Constructors

constructor

  • new VaultsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): VaultsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: VaultsWaiter

targetService

targetService: string = "Vaults"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

cancelSecretDeletion

  • Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret's lifecycle state to what it was before you scheduled the secret for deletion.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelSecretDeletion API.

    Parameters

    Returns Promise<CancelSecretDeletionResponse>

    CancelSecretDeletionResponse

cancelSecretRotation

  • Cancels the ongoing secret rotation. The cancellation is contingent on how far the rotation process has progressed. Upon cancelling a rotation, all future rotations are also disabled.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelSecretRotation API.

    Parameters

    Returns Promise<CancelSecretRotationResponse>

    CancelSecretRotationResponse

cancelSecretVersionDeletion

changeSecretCompartment

close

  • close(): void

createSecret

  • Creates a new secret according to the details of the request.

    This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSecret API.

    Parameters

    Returns Promise<CreateSecretResponse>

    CreateSecretResponse

createWaiters

  • Creates a new VaultsWaiter for resources for this service.

    Parameters

    • workRequestClient: WorkRequestClient

      The work request service client used to query for work request status

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns VaultsWaiter

    The service waiters.

getSecret

  • Gets information about the specified secret. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecret API.

    Parameters

    Returns Promise<GetSecretResponse>

    GetSecretResponse

getSecretVersion

  • Gets information about the specified version of a secret.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecretVersion API.

    Parameters

    Returns Promise<GetSecretVersionResponse>

    GetSecretVersionResponse

getWaiters

listAllSecretVersions

  • NOTE: This function is deprecated in favor of listSecretVersionsRecordIterator function. Creates a new async iterator which will iterate over the models.SecretVersionSummary objects contained in responses from the listSecretVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecretVersionSummary>

listAllSecretVersionsResponses

  • NOTE: This function is deprecated in favor of listSecretVersionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSecretVersions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSecretVersionsResponse>

listAllSecrets

  • NOTE: This function is deprecated in favor of listSecretsRecordIterator function. Creates a new async iterator which will iterate over the models.SecretSummary objects contained in responses from the listSecrets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecretSummary>

listAllSecretsResponses

  • NOTE: This function is deprecated in favor of listSecretsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSecrets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSecretsResponse>

listSecretVersions

  • Lists all secret versions for the specified secret. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecretVersions API.

    Parameters

    Returns Promise<ListSecretVersionsResponse>

    ListSecretVersionsResponse

listSecretVersionsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<SecretVersionSummary>

listSecretVersionsResponseIterator

listSecrets

  • Lists all secrets in the specified vault and compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecrets API.

    Parameters

    Returns Promise<ListSecretsResponse>

    ListSecretsResponse

listSecretsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<SecretSummary>

listSecretsResponseIterator

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

    Parameters

    Returns AsyncIterableIterator<ListSecretsResponse>

rotateSecret

  • API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RotateSecret API.

    Parameters

    Returns Promise<RotateSecretResponse>

    RotateSecretResponse

scheduleSecretDeletion

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ScheduleSecretDeletion API.

    Parameters

    Returns Promise<ScheduleSecretDeletionResponse>

    ScheduleSecretDeletionResponse

scheduleSecretVersionDeletion

  • Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as DEPRECATED.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ScheduleSecretVersionDeletion API.

    Parameters

    Returns Promise<ScheduleSecretVersionDeletionResponse>

    ScheduleSecretVersionDeletionResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateSecret

  • Updates the properties of a secret. Specifically, you can update the version number of the secret to make that version number the current version. You can also update a secret's description, its free-form or defined tags, rules and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the same time. Furthermore, the secret must in an ACTIVE lifecycle state to be updated.

    This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSecret API.

    Parameters

    Returns Promise<UpdateSecretResponse>

    UpdateSecretResponse