openapi: 3.2.0
info:
  title: MTLS Service Public certificates API
  description: "Use the MTLS Service API to securely retrieve public certificates for your Adobe applications.\n- **Related documentation**:\n  - [MTLS Service API overview](https://experienceleague.adobe.com/en/docs/experience-platform/data-governance/mtls-api/overview)\n  - [Public certificate endpoint](https://experienceleague.adobe.com/en/docs/experience-platform/data-governance/mtls-api/public-certificate-endpoint)\n\n- **Visualize API calls with Postman (a free, third-party software)**:\n  * [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n  * [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n- **API paths**:\n  * PLATFORM Gateway URL: https://<span>platform.adobe.io\n  * Base path for this API: /data/core/mtls\n  * Example of a complete path for making a call to \"/v1/certificate/public-certificate\": https://<span>platform.adobe.io/data/core/mtls/v1/certificate/public-certificate\n\n- **Required headers**:\n  * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, \n    see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n"
  version: 1.0.0
servers:
- url: https://{environment}.adobe.io/
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Public certificates
  description: 'Externally verify the authenticity of the certificates to enhance trust in safeguarding sensitive information.

    '
paths:
  /v1/certificate/public-certificate:
    get:
      tags:
      - Public certificates
      summary: List public certificates for your Adobe applications
      operationId: retrieveCertificates
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page-number'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/content-type'
      responses:
        200:
          x-summary: Success
          description: Returns the public certificates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificateResponse'
components:
  schemas:
    certificateResponse:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              certCommonName:
                type: string
                description: 'The common name of the certificate, indicating the entity to which the certificate was issued.

                  '
                example: Adobe Experience Platform
              publicCertificate:
                type: string
                description: 'The public certificate in PEM format, used for verifying secure communications. Note, this example  is truncated for brevity.

                  '
                example: '-----BEGIN CERTIFICATE-----

                  MIIDQTCCAimgAwIBAgITBmyfACAfma......KJY5u89CjAwj

                  -----END CERTIFICATE-----'
              expiryDate:
                type: string
                format: date-time
                description: 'The date and time when the certificate expires, in ISO 8601 format.

                  '
                example: '2024-07-17T21:27:57.434Z'
        total:
          type: integer
          description: 'The total number of certificates available.

            '
          example: 1
        count:
          type: integer
          description: 'The number of certificates returned in the current response.

            '
          example: 1
        _links:
          type: object
          description: Contains the URLs for navigation between response pages.
          properties:
            next:
              type: object
              properties:
                href:
                  type: string
                  example: https://platform.adobe.io/data/core/mtls/v1/certificate/public-certificate/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809
                  description: The URL for the next response page.
                templated:
                  type: boolean
                  description: Indicates if the sibling `href` property is a template.
            prev:
              type: object
              properties:
                href:
                  type: string
                  example: https://platform.adobe.io/data/core/mtls/v1/certificate/public-certificate/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809
                  description: The URL for the previous response page.
                templated:
                  type: boolean
                  description: Indicates if the sibling `href` property is a template.
            page:
              type: object
              properties:
                href:
                  type: string
                  example: https://platform.adobe.io/data/core/mtls/v1/certificate/public-certificate/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809
                  description: The URL for the currently displayed response page.
                templated:
                  type: boolean
                  description: Indicates if the sibling `href` property is a template.
  parameters:
    authorization:
      name: Authorization
      in: header
      description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: 'This parameter limits the response to a specific number of objects. This must be a positive number.  For example, `limit=10`.

        '
      schema:
        maximum: 100
        type: integer
        default: 25
        example: 1
    content-type:
      name: Content-Type
      in: header
      description: The type of content being sent in the body of the request. This value should be `application/json`.
      required: true
      schema:
        type: string
    page-number:
      name: page
      in: query
      description: 'The page index to return for the listing response (for example, `page=0`). Can be used in conjunction  with `limit` to manage response pagination. **NOTE**: The response includes information about the current, previous, and next pages. Use the page numbers from  this information to navigate through the pages in your subsequent API calls.

        '
      schema:
        type: integer
        default: 1
    x-api-key:
      name: x-api-key
      in: header
      description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-gw-ims-org-id:
      name: x-gw-ims-org-id
      in: header
      description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string