Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SecretsClient

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

  • SecretsClient

Constructors

constructor

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

Properties

Protected _circuitBreaker

_circuitBreaker: null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://secrets.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}.

    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

Methods

getSecretBundle

  • Gets a secret bundle that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT will be returned.

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

    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 GetSecretBundle API.

    Parameters

    Returns Promise<GetSecretBundleResponse>

    GetSecretBundleResponse

getSecretBundleByName

  • Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.

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

    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 GetSecretBundleByName API.

    Parameters

    Returns Promise<GetSecretBundleByNameResponse>

    GetSecretBundleByNameResponse

listAllSecretBundleVersions

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

    Parameters

    Returns AsyncIterableIterator<SecretBundleVersionSummary>

listAllSecretBundleVersionsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListSecretBundleVersionsResponse>

listSecretBundleVersions

listSecretBundleVersionsRecordIterator

listSecretBundleVersionsResponseIterator