Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CertificatesManagementClient

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

  • CertificatesManagementClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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: CertificatesManagementWaiter

targetService

targetService: string = "CertificatesManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

cancelCertificateAuthorityDeletion

cancelCertificateAuthorityVersionDeletion

cancelCertificateDeletion

  • Cancels the pending deletion of the specified certificate. Canceling a scheduled deletion restores the certificate's lifecycle state to what it was before you scheduled the certificate 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 CancelCertificateDeletion API.

    Parameters

    Returns Promise<CancelCertificateDeletionResponse>

    CancelCertificateDeletionResponse

cancelCertificateVersionDeletion

changeCaBundleCompartment

changeCertificateAuthorityCompartment

changeCertificateCompartment

close

  • close(): void

createCaBundle

createCertificate

createCertificateAuthority

createWaiters

deleteCaBundle

getAssociation

getCaBundle

getCertificate

getCertificateAuthority

getCertificateAuthorityVersion

getCertificateVersion

getWaiters

listAssociations

  • Lists all associations that match the query parameters. Optionally, you can use the parameter FilterByAssociationIdQueryParam to limit the result set to a single item that matches the specified association.

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

    Parameters

    Returns Promise<ListAssociationsResponse>

    ListAssociationsResponse

listCaBundles

  • Lists all CA bundles that match the query parameters. Optionally, you can use the parameter FilterByCaBundleIdQueryParam to limit the result set to a single item that matches the specified CA bundle.

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

    Parameters

    Returns Promise<ListCaBundlesResponse>

    ListCaBundlesResponse

listCertificateAuthorities

  • Lists all certificate authorities (CAs) in the specified compartment. Optionally, you can use the parameter FilterByCertificateAuthorityIdQueryParam to limit the results to a single item that matches the specified CA.

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

    Parameters

    Returns Promise<ListCertificateAuthoritiesResponse>

    ListCertificateAuthoritiesResponse

listCertificateAuthorityVersions

  • Lists all versions for the specified certificate authority (CA). Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the results to a single item that matches the specified version number.

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

    Parameters

    Returns Promise<ListCertificateAuthorityVersionsResponse>

    ListCertificateAuthorityVersionsResponse

listCertificateVersions

  • Lists all certificate versions for the specified certificate. Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the result set to a single item that matches the specified version number.

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

    Parameters

    Returns Promise<ListCertificateVersionsResponse>

    ListCertificateVersionsResponse

listCertificates

  • Lists all certificates that match the query parameters. Optionally, you can use the parameter FilterByCertificateIdQueryParam to limit the result set to a single item that matches the specified certificate.

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

    Parameters

    Returns Promise<ListCertificatesResponse>

    ListCertificatesResponse

revokeCertificateAuthorityVersion

revokeCertificateVersion

scheduleCertificateAuthorityDeletion

  • Schedules the deletion of the specified certificate authority (CA). This sets the lifecycle state of the CA to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthority.

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

    Parameters

    Returns Promise<ScheduleCertificateAuthorityDeletionResponse>

    ScheduleCertificateAuthorityDeletionResponse

scheduleCertificateAuthorityVersionDeletion

  • Schedules the deletion of the specified certificate authority (CA) version. This sets the lifecycle state of the CA version to PENDING_DELETION and then deletes it after the specified retention period ends. If needed, you can determine the status of the deletion by using GetCertificateAuthorityVersion.

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

    Parameters

    Returns Promise<ScheduleCertificateAuthorityVersionDeletionResponse>

    ScheduleCertificateAuthorityVersionDeletionResponse

scheduleCertificateDeletion

  • Schedules the deletion of the specified certificate. This sets the lifecycle state of the certificate to PENDING_DELETION and then deletes it after the specified retention period ends. You can subsequently use GetCertificate to determine the current deletion status.

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

    Parameters

    Returns Promise<ScheduleCertificateDeletionResponse>

    ScheduleCertificateDeletionResponse

scheduleCertificateVersionDeletion

  • Schedules the deletion of the specified certificate version. This sets the lifecycle state of the certificate version to PENDING_DELETION and then deletes it after the specified retention period ends. You can only delete a certificate version if the certificate version rotation state is marked as DEPRECATED.

    You can subsequently use `GetCertificateVersion` to determine the current certificate version deletion status.

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

    Parameters

    Returns Promise<ScheduleCertificateVersionDeletionResponse>

    ScheduleCertificateVersionDeletionResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateCaBundle

updateCertificate

updateCertificateAuthority