PagoPA Signature API

openapi: 3.2.0
info:
  title: Pagopa Signature API
  version: 3.0.0
  contact:
    name: PagoPA S.p.A
    url: https://www.interop.pagopa.it/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-api-id: 5ca54741-8f62-4aad-ab79-13ae762920e3
  x-audience:
  - public
  x-summary: Check the validity of the signatue for individuals and non-individual entities
  description: 'Operations tagged Signature across 2 of this provider''s published API definitions: interop-keychain-mock.yaml, pagopa-pdnd-attestation-keychain-mock-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Ambiente di Attestazione
  url: https://mtls.eservices.att.interop.pagopa.it/
tags:
- name: Signature
paths:
  /keychain-mock/signature:
    get:
      summary: Carry out a validation of the input signature
      operationId: get_signature
      tags:
      - Signature
      description: Returns response with signature
      responses:
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
        default:
          $ref: '#/components/responses/default'
        '200':
          description: 'The server was able to verify the validity of the signature.

            '
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponseSignature'
    servers:
    - description: Ambiente di Attestazione
      url: https://mtls.eservices.att.interop.pagopa.it/
  /keychain-mock/verify:
    post:
      summary: Verifies the input message
      operationId: post_verify_message
      tags:
      - Signature
      description: 'This endpoint takes a message input and returns a status indicating

        whether the message verification was successful or not.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputMessage'
            example:
              message: risposta generata con successo
      responses:
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
        default:
          $ref: '#/components/responses/default'
        '200':
          description: 'The server has verified the message and returns the status.

            '
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationResponse'
    servers:
    - description: Ambiente di Attestazione
      url: https://mtls.eservices.att.interop.pagopa.it/
components:
  headers:
    WWW-Authenticate:
      description: 'Auth realm=APIkey

        See https://tools.ietf.org/html/rfc7235#section-4.1'
      schema:
        type: string
    Retry-After:
      description: 'Retry contacting the endpoint *at least* after seconds.

        See https://tools.ietf.org/html/rfc7231#section-7.1.3'
      schema:
        type: string
    X-RateLimit-Limit:
      description: The number of allowed requests in the current period
      schema:
        type: string
    X-RateLimit-Remaining:
      description: The number of remaining requests in the current period
      schema:
        type: string
    X-RateLimit-Reset:
      description: The number of seconds left in the current period
      schema:
        type: string
  schemas:
    SuccessResponseSignature:
      type: object
      properties:
        message:
          type: string
          example: risposta generata con successo
    InputMessage:
      type: object
      properties:
        message:
          type: string
          example: risposta generata con successo
    Problem:
      properties:
        detail:
          description: 'A human readable explanation specific to this occurrence of the

            problem. You MUST NOT expose internal informations, personal

            data or implementation details through this field.

            '
          example: Request took too long to complete.
          type: string
        instance:
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
          format: uri
          type: string
        status:
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          example: 503
          format: int32
          minimum: 100
          type: integer
          exclusiveMaximum: 600
        title:
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized); example: Service Unavailable

            '
          type: string
        type:
          default: about:blank
          description: 'An absolute URI that identifies the problem type.  When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          format: uri
          type: string
      type: object
    VerificationResponse:
      type: object
      properties:
        status:
          type: string
          description: 'Indicates if the message verification was successful.

            '
        message:
          type: string
          description: 'Contains an error message if status is "KO"; otherwise, it may be empty.

            '
          example: Eventuale messaggio di errore
  responses:
    429TooManyRequests:
      description: Too many requests
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
    401Unauthorized:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      headers:
        WWW-Authenticate:
          $ref: '#/components/headers/WWW-Authenticate'
      description: Not authorized
    400BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Bad Request
    default:
      description: Unexpected error
    503ServiceUnavailable:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: Service Unavailable
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
x-refined-from:
- interop-keychain-mock.yaml
- pagopa-pdnd-attestation-keychain-mock-openapi.yml