1. REST API for Oracle Integration 3
  2. Tasks
  3. Integrations
  4. Certificates

Retrieve Certificates

get

/ic/api/integration/v1/certificates

Retrieves information about all the certificates.

Request

Query Parameters
  • Includes additional details about the certificates in the response.
  • This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
  • Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list certificates starting at the 4th item, and the list will contain 16 items.
  • Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list certificates starting at the 4th item, and the list will contain 16 items.

  • Lists certificates ordered by name, or expiry.

    Valid values:

    • name: Order certificates by certificate name. Example: orderBy=name.
    • expiry: Order certificates by later expiry date. Example: orderBy=expiry.
    • expiry:asc: Order certificates by sooner expiry date. Example: orderBy=expiry:asc

  • Filters certificates by name, status, and type.

    Valid parameters:

    • name: Name of the certificate. Supports exact matches or contains. For example:
      • To retrieve certificates that are an exact match in the certificate name, specify: 
        q={name:'My Certificate Name'}
        .
      • To retrieve all certificates that contain the specified string in the certificate name, specify: 
        q={name: /Oracle/}
    • status: Status of the certificate. Valid values: CONFIGURED, INPROGRESS. INPROGRESS is displayed as Draft in the graphical user interface.

      For example, to retrieve all certificates that contain PGP and have the status configured, specify:

      {name : /PGP/, status : 'CONFIGURED'}
    • type: Type of the certificate.

      Valid values: DIGITALSIGNATURE, PGP, SAML, SIGNKEY, X509.

  • API returns a minimal or full view of the response.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : CertificatesRs
Match All
Show Source
Nested Schema : GenericRestRs
Type: object
Show Source
Nested Schema : CertificatesRs-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
List of Certificates
Show Source
Nested Schema : CertificateRs
Match All
Show Source
Nested Schema : IdResource
Match All
Show Source
Nested Schema : GenericRestResource
Type: object
Show Source
Nested Schema : IdResource-allOf[1]
Type: object
Show Source
Nested Schema : CertificateRs-allOf[2]
Type: object
Show Source
Nested Schema : content
Type: array
Show Source
Nested Schema : metaData
Type: object
Additional Properties Allowed
Show Source

400 Response

Malformed parameters

500 Response

Server error
Back to Top

Examples

The following example shows how to get details of certificates by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Get certificates that contain PGP and have the status CONFIGURED

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /PGP/, status: 'CONFIGURED'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

Example: Paginate through returned certificates

Pagination is done with limit and offset. In this example, we list certificates starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

Example: Get certificates ordered by the expiry date in descending order

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=expiry" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance

Example: Get all certificates

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/certificates?integrationInstance=service-instance
Back to Top