openapi: 3.2.0
info:
  description: API for retrieving certificates.
  title: Service Retrieval Certificates API
  version: '20210224'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/cb5ac66ac0594784751214eea87e9644053b3680f24b6447f086ffc22968901d.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Certificates Service Retrieval API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/cb5ac66ac0594784751214eea87e9644053b3680f24b6447f086ffc22968901d.yaml
    what: the harvested document for Certificates Service Retrieval API
servers:
- url: https://certificates.$region.oci.oraclecloud.com/20210224
tags:
- description: Certificates Service Retrieval API
  name: certificates
paths:
  /caBundles/{caBundleId}:
    get:
      description: 'Gets the bundle for the specified CA bundle.

        '
      operationId: GetCaBundle
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CaBundleIdRequiredPathParam'
      responses:
        200:
          description: The specified CA bundle.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaBundle'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a CA bundle.
      tags:
      - certificates
      x-example: 'GET /20210224/caBundles/<var>&lt;caBundleOCID&gt;</var>?versionNumber=<var>&lt;versionNumber&gt;</var>

        Host: retrieval.certificates.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /certificateAuthorityBundles/{certificateAuthorityId}:
    get:
      description: 'Gets a bundle for a certificate authority (CA) that matches either the specified `stage`, `name`, or `versionNumber` parameter.

        If none of these parameters are provided, the bundle for the CA version marked as `CURRENT` is returned.

        '
      operationId: GetCertificateAuthorityBundle
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam'
      - $ref: '#/components/parameters/CertificateAuthorityVersionNumberQueryParam'
      - $ref: '#/components/parameters/CertificateAuthorityVersionNameQueryParam'
      - $ref: '#/components/parameters/CertificateAuthorityStageQueryParam'
      responses:
        200:
          description: A bundle for the specified CA.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateAuthorityBundle'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a certificate authority bundle.
      tags:
      - certificates
      x-example: 'GET /20210224/certificateAuthorityBundles/<var>&lt;certificateAuthorityOCID&gt;</var>?versionNumber=<var>&lt;versionNumber&gt;</var>

        Host: retrieval.certificates.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /certificateAuthorityBundles/{certificateAuthorityId}/versions:
    get:
      description: Lists all versions of bundles for a given certificate authority (CA).
      operationId: ListCertificateAuthorityBundleVersions
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CertificateAuthorityIdRequiredPathParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: A list of version objects for the specified CA's bundles.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateAuthorityBundleVersionCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists all versions of bundles for a certificate authority.
      tags:
      - certificates
      x-example: 'GET /20210224/certificateAuthorityBundles/<var>&lt;certificateAuthorityBundleOCID&gt;</var>?versionNumber=<var>&lt;versionNumber&gt;</var>

        Host: retrieval.certificates.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/CertificateAuthorityBundleVersionSummary'
  /certificateBundles/{certificateId}:
    get:
      description: 'Gets a certificate bundle that matches either the specified `stage`, `versionName`, or `versionNumber` parameter.

        If none of these parameters are provided, the bundle for the certificate version marked as `CURRENT` is returned.


        By default, the private key is not included in the query result, and only the certificate bundle is returned.

        If you also need the private key, you can use the parameter `CertificateBundleTypeQueryParam` to indicate that you want a certificate bundle along with its private key as a response to your request.

        '
      operationId: GetCertificateBundle
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CertificateIdRequiredPathParam'
      - $ref: '#/components/parameters/CertificateVersionNumberQueryParam'
      - $ref: '#/components/parameters/CertificateVersionNameQueryParam'
      - $ref: '#/components/parameters/StageQueryParam'
      - $ref: '#/components/parameters/CertificateBundleTypeQueryParam'
      responses:
        200:
          description: A certificate bundle.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateBundle'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a certificate bundle.
      tags:
      - certificates
      x-example: 'GET /20210224/certificateBundles/<var>&lt;certificateOCID&gt;</var>?versionNumber=<var>&lt;versionNumber&gt;</var>

        Host: retrieval.certificates.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /certificateBundles/{certificateId}/versions:
    get:
      description: Lists all certificate bundle versions for the specified certificate.
      operationId: ListCertificateBundleVersions
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CertificateIdRequiredPathParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: A list of certificate bundle version objects.
          headers:
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateBundleVersionCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists all certificate bundle versions.
      tags:
      - certificates
      x-example: 'GET /20210224/certificateBundles/<var>&lt;certificateBundleOCID&gt;</var>/versions

        Host: retrieval.certificates.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/CertificateBundleVersionSummary'
components:
  schemas:
    CertificateBundleVersionCollection:
      description: The results of a certificate bundle versions search. Results contain certificate bundle version summary objects.
      properties:
        items:
          description: A list of certificate bundle version summary objects.
          items:
            $ref: '#/components/schemas/CertificateBundleVersionSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: An error.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    CertificateAuthorityBundleVersionCollection:
      description: The results of a certificate authority (CA) version search. Results contain CA version summary objects and other data.
      properties:
        items:
          description: A list of CA version summary objects.
          items:
            $ref: '#/components/schemas/CertificateAuthorityBundleVersionSummary'
          type: array
      required:
      - items
      type: object
    CaBundle:
      description: 'The contents of the CA bundle (root and intermediate certificates), properties of the CA bundle, and user-provided contextual metadata for the CA bundle.

        '
      properties:
        caBundlePem:
          description: Certificates (in PEM format) in the CA bundle. Can be of arbitrary length.
          minLength: 1
          type: string
        id:
          description: The OCID of the CA bundle.
          maxLength: 255
          minLength: 1
          type: string
        name:
          description: 'A user-friendly name for the CA bundle. Names are unique within a compartment. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - name
      - caBundlePem
      type: object
      x-example: "{\n  \"id\": \"ocid1.cabundle.oc1.iad.exampleae47ajxyat2artzcvbd24gkxtpoxor5cyrflfauxu6sh6bouitfoq\",\n  \"name\": \"test-ca-bundle-cvb-3\",\n  \"description\": \"my CA bundle\",\n  \"timeCreated\": \"2021-04-12T18:32:12.569Z\",\n  \"lifecycleState\": \"CREATING\",\n  \"lifecycleDetails\": null,\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleawwcufihrc62gpbetocvbswgoj4w7rg5q4fwbg2mifauxcxbtliaa\",\n  \"freeformTags\": {},\n  \"definedTags\": {}\n}\n"
    CertificateAuthorityBundle:
      description: 'The contents of the certificate, properties of the certificate (and certificate version), and user-provided contextual metadata for the certificate.

        '
      properties:
        certChainPem:
          default: null
          description: The certificate chain (in PEM format) for this CA version.
          maxLength: 51200
          minLength: 1
          type: string
        certificateAuthorityId:
          description: The OCID of the certificate authority (CA).
          type: string
        certificateAuthorityName:
          description: The name of the CA.
          maxLength: 255
          minLength: 1
          type: string
        certificatePem:
          description: The certificate (in PEM format) for this CA version.
          maxLength: 10240
          minLength: 1
          type: string
        revocationStatus:
          $ref: '#/components/schemas/RevocationStatus'
        serialNumber:
          description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets.

            Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

            '
          maxLength: 59
          minLength: 2
          type: string
        stages:
          description: A list of rotation states for this CA.
          items:
            enum:
            - CURRENT
            - PENDING
            - PENDING_ACTIVATION
            - LATEST
            - PREVIOUS
            - DEPRECATED
            - FAILED
            type: string
            x-obmcs-top-level-enum: '#/definitions/VersionStage'
          type: array
        timeCreated:
          description: 'A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        validity:
          $ref: '#/components/schemas/Validity'
        versionName:
          default: null
          description: The name of the CA.
          maxLength: 50
          minLength: 1
          type: string
        versionNumber:
          description: The version number of the CA.
          format: int64
          minimum: 1
          type: integer
      required:
      - certificateAuthorityId
      - certificateAuthorityName
      - certificatePem
      - serialNumber
      - validity
      - stages
      - timeCreated
      - versionNumber
      type: object
      x-example: "{\n  \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxya5r64cqcvbphd7vn4ifypr3wn3lqkfhjxfauxqohfpmoa\",\n  \"certificateAuthorityName\": \"test-cvb-1\",\n  \"serialNumber\": \"1234567890419170222282007451413738675751123456789\",\n  \"certificatePem\": \"-----BEGIN CERTIFICATE-----<var>&lt;certificateContents&gt;</var>-----END CERTIFICATE-----\",\n  \"certChainPem\": \"-----BEGIN CERTIFICATE-----<var>&lt;certificateContents&gt;</var>-----END CERTIFICATE-----\",\n  \"versionName\": null,\n  \"timeCreated\": \"2021-04-07T00:49:42.725Z\",\n  \"versionNumber\": 3,\n  \"validity\": {\n    \"timeOfValidityNotBefore\": \"2021-04-07T00:49:42.134Z\",\n    \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n  },\n  \"stages\": [\n    \"CURRENT\",\n    \"LATEST\"\n  ],\n  \"revocationStatus\": null\n}\n"
    CertificateAuthorityBundleVersionSummary:
      description: 'The properties of a version of a bundle for a certificate authority (CA). Certificate authority bundle version summary objects do not include the actual contents of the certificate.

        '
      properties:
        certificateAuthorityId:
          description: The OCID of the certificate authority (CA).
          type: string
        certificateAuthorityName:
          description: The name of the CA.
          maxLength: 255
          minLength: 1
          type: string
        revocationStatus:
          $ref: '#/components/schemas/RevocationStatus'
        serialNumber:
          description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets.

            Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

            '
          maxLength: 59
          minLength: 2
          type: string
        stages:
          description: A list of rotation states for this CA version.
          items:
            enum:
            - CURRENT
            - PENDING
            - PENDING_ACTIVATION
            - LATEST
            - PREVIOUS
            - DEPRECATED
            - FAILED
            type: string
            x-obmcs-top-level-enum: '#/definitions/VersionStage'
          type: array
        timeCreated:
          description: 'An optional property indicating when the CA version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfDeletion:
          default: null
          description: 'An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        validity:
          $ref: '#/components/schemas/Validity'
        versionName:
          default: null
          description: 'The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.

            '
          maxLength: 50
          minLength: 1
          type: string
        versionNumber:
          description: The version number of the CA.
          format: int64
          type: integer
      required:
      - certificateAuthorityId
      - versionNumber
      - certificateAuthorityName
      - stages
      - timeCreated
      type: object
    RevocationStatus:
      description: The current revocation status of the certificate or certificate authority (CA).
      properties:
        revocationReason:
          description: The reason that the certificate or CA was revoked.
          enum:
          - UNSPECIFIED
          - KEY_COMPROMISE
          - CA_COMPROMISE
          - AFFILIATION_CHANGED
          - SUPERSEDED
          - CESSATION_OF_OPERATION
          - PRIVILEGE_WITHDRAWN
          - AA_COMPROMISE
          type: string
          x-obmcs-top-level-enum: '#/definitions/RevocationReason'
        timeRevoked:
          description: The time when the certificate or CA was revoked.
          format: date-time
          type: string
      required:
      - timeRevoked
      - revocationReason
      type: object
    Validity:
      description: An object that describes a period of time during which an entity is valid.
      properties:
        timeOfValidityNotAfter:
          description: 'The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfValidityNotBefore:
          description: 'The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - timeOfValidityNotBefore
      - timeOfValidityNotAfter
    CertificateBundle:
      description: 'The contents of the certificate, properties of the certificate (and certificate version), and user-provided contextual metadata for the certificate.

        '
      discriminator:
        propertyName: certificateBundleType
      properties:
        certChainPem:
          default: null
          description: The certificate chain (in PEM format) for the certificate bundle.
          maxLength: 51200
          minLength: 1
          type: string
        certificateBundleType:
          description: The type of certificate bundle, which indicates whether the private key fields are included.
          enum:
          - CERTIFICATE_CONTENT_PUBLIC_ONLY
          - CERTIFICATE_CONTENT_WITH_PRIVATE_KEY
          type: string
          x-obmcs-inline-enum: true
        certificateId:
          description: The OCID of the certificate.
          maxLength: 255
          minLength: 1
          type: string
        certificateName:
          description: The name of the certificate.
          maxLength: 255
          minLength: 1
          type: string
        certificatePem:
          default: null
          description: The certificate in PEM format.
          maxLength: 10240
          minLength: 1
          type: string
        revocationStatus:
          $ref: '#/components/schemas/RevocationStatus'
        serialNumber:
          description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets.

            Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

            '
          maxLength: 59
          minLength: 2
          type: string
        stages:
          description: A list of rotation states for the certificate bundle.
          items:
            enum:
            - CURRENT
            - PENDING
            - PENDING_ACTIVATION
            - LATEST
            - PREVIOUS
            - DEPRECATED
            - FAILED
            type: string
            x-obmcs-top-level-enum: '#/definitions/VersionStage'
          type: array
        timeCreated:
          description: 'An optional property indicating when the certificate version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        validity:
          $ref: '#/components/schemas/Validity'
        versionName:
          default: null
          description: The name of the certificate version.
          maxLength: 50
          minLength: 1
          type: string
        versionNumber:
          description: The version number of the certificate.
          format: int64
          type: integer
      required:
      - certificateBundleType
      - certificateId
      - certificateName
      - versionNumber
      - timeCreated
      - validity
      - stages
      - serialNumber
      type: object
      x-example: "{\n  \"certificateBundleType\": \"CERTIFICATE_CONTENT_PUBLIC_ONLY\",\n  \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27ghmlu2cvbcd4hn7ho4qfauxdhzz5a5matr2jgq\",\n  \"certificateName\": null,\n  \"versionNumber\": 3,\n  \"serialNumber\": \"123456789467871985158273573384545629334123456789\",\n  \"certificatePem\": \"-----BEGIN CERTIFICATE-----<var>&lt;certificateContents&gt;</var>-----END CERTIFICATE-----\",\n  \"certChainPem\": \"-----BEGIN CERTIFICATE-----<var>&lt;certificateContents&gt;</var>-----END CERTIFICATE-----\",\n  \"timeCreated\": \"2021-04-07T23:01:31.951Z\",\n  \"validity\": {\n    \"timeOfValidityNotBefore\": \"2021-04-07T23:01:31.720Z\",\n    \"timeOfValidityNotAfter\": \"2022-05-07T00:00:00.000Z\"\n  },\n  \"versionName\": null,\n  \"stages\": [\n    \"CURRENT\",\n    \"LATEST\"\n  ],\n  \"revocationStatus\": null\n}\n"
    CertificateBundleVersionSummary:
      description: 'The properties of the certificate bundle. Certificate bundle version summary objects do not include the actual contents of the certificate.

        '
      properties:
        certificateId:
          description: The OCID of the certificate.
          maxLength: 255
          minLength: 1
          type: string
        certificateName:
          description: The name of the certificate.
          maxLength: 255
          minLength: 1
          type: string
        revocationStatus:
          $ref: '#/components/schemas/RevocationStatus'
        serialNumber:
          description: 'A unique certificate identifier used in certificate revocation tracking, formatted as octets.

            Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`

            '
          maxLength: 59
          minLength: 2
          type: string
        stages:
          description: A list of rotation states for this certificate bundle version.
          items:
            enum:
            - CURRENT
            - PENDING
            - PENDING_ACTIVATION
            - LATEST
            - PREVIOUS
            - DEPRECATED
            - FAILED
            type: string
            x-obmcs-top-level-enum: '#/definitions/VersionStage'
          type: array
        timeCreated:
          description: 'An optional property indicating when the certificate version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfDeletion:
          default: null
          description: 'An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2019-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        validity:
          $ref: '#/components/schemas/Validity'
        versionName:
          default: null
          description: The name of the certificate version.
          maxLength: 50
          minLength: 1
          type: string
        versionNumber:
          description: The version number of the certificate.
          format: int64
          type: integer
      required:
      - certificateId
      - versionNumber
      - timeCreated
      - stages
      - certificateName
      type: object
      x-example: "{\n  \"certificateId\": \"ocid1.certificate.oc1.iad.exampleae47ajxyajghg27ghmlu2cvbcd4hn7ho4qfauxdhzz5a5matr2jgq\",\n  \"serialNumber\": \"123456789467871985158273573384545629334123456789\",\n  \"versionName\": null,\n  \"certificateName\": null,\n  \"versionNumber\": 3,\n  \"timeCreated\": \"2021-04-07T23:01:31.951Z\",\n  \"validity\": {\n    \"timeOfValidityNotBefore\": \"2021-04-07T23:01:31.720Z\",\n    \"timeOfValidityNotAfter\": \"2022-05-07T00:00:00.000Z\"\n  },\n  \"timeOfDeletion\": null,\n  \"stages\": [\n    \"CURRENT\",\n    \"LATEST\"\n  ],\n  \"revocationStatus\": null\n}\n"
  parameters:
    SortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default

        order for `VERSION_NUMBER` is ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - VERSION_NUMBER
        default: VERSION_NUMBER
    CertificateAuthorityVersionNumberQueryParam:
      description: The version number of the certificate authority (CA).
      in: query
      name: versionNumber
      required: false
      schema:
        type: integer
        format: int64
        default: 0
    CertificateAuthorityVersionNameQueryParam:
      description: 'The name of the certificate authority (CA). (This might be referred to as the name of the CA version, as every CA consists of at least one version.) Names are unique across versions of a given CA.

        '
      in: query
      name: certificateAuthorityVersionName
      required: false
      x-default-description: The default value is null, which means that this query parameter is ignored.
      schema:
        type: string
        maxLength: 50
        minLength: 1
    CertificateVersionNumberQueryParam:
      description: The version number of the certificate. The default value is 0, which means that this query parameter is ignored.
      in: query
      name: versionNumber
      required: false
      schema:
        type: integer
        format: int64
        default: 0
    CertificateIdRequiredPathParam:
      description: The OCID of the certificate.
      in: path
      name: certificateId
      required: true
      schema:
        type: string
    StageQueryParam:
      description: The rotation state of the certificate version.
      in: query
      name: stage
      required: false
      x-default-description: The default value is null.
      x-obmcs-inline-enum: true
      schema:
        type: string
        enum:
        - CURRENT
        - PENDING
        - LATEST
        - PREVIOUS
        - DEPRECATED
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).

        '
      in: query
      name: sortOrder
      required: false
      x-obmcs-inline-enum: true
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    CertificateAuthorityStageQueryParam:
      description: The rotation state of the certificate version.
      in: query
      name: stage
      required: false
      x-default-description: The default value is null.
      x-obmcs-inline-enum: true
      schema:
        type: string
        enum:
        - CURRENT
        - PENDING
        - PENDING_ACTIVATION
        - LATEST
        - PREVIOUS
        - DEPRECATED
    CertificateBundleTypeQueryParam:
      description: 'The type of certificate bundle. By default, the private key fields are not returned. When querying for certificate bundles, to return results with certificate contents, the private key in PEM format, and the private key passphrase, specify the value of this parameter as `CERTIFICATE_CONTENT_WITH_PRIVATE_KEY`.

        '
      in: query
      name: certificateBundleType
      required: false
      x-default-description: 'The default value is null, which means that the private key fields in the certificate bundle are not included in the query results.

        '
      x-obmcs-inline-enum: true
      schema:
        type: string
        enum:
        - CERTIFICATE_CONTENT_PUBLIC_ONLY
        - CERTIFICATE_CONTENT_WITH_PRIVATE_KEY
    OpcRequestIdHeaderParam:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,

        please provide the request ID.

        '
      in: header
      name: opc-request-id
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    CertificateAuthorityIdRequiredPathParam:
      description: The OCID of the certificate authority (CA).
      in: path
      name: certificateAuthorityId
      required: true
      schema:
        type: string
    CaBundleIdRequiredPathParam:
      description: The OCID of the CA bundle.
      in: path
      name: caBundleId
      required: true
      schema:
        type: string
    CertificateVersionNameQueryParam:
      description: 'The name of the certificate. (This might be referred to as the name of the certificate version, as every certificate consists of at least one version.) Names are unique across versions of a given certificate.

        '
      in: query
      name: certificateVersionName
      required: false
      x-default-description: The default value is null, which means that this query parameter is ignored.
      schema:
        type: string
        maxLength: 50
        minLength: 1
  responses:
    DefaultError:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

            a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-oracle-package: com.oracle.bmc.swagger.ocicerts