openapi: 3.2.0
info:
  title: Pagopa Manage Authorization API
  version: 4.1.1
  contact:
    name: PagoPA S.p.A.
    url: https://docs.pagopa.it/io-guida-tecnica/
  x-logo:
    url: https://io.italia.it/assets/img/io-logo-blue.svg
  description: 'Operations tagged manage-authorization across 2 of this provider''s published API definitions: io-functions-services.yaml, pagopa-io-services-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.io.pagopa.it/api/v1
tags:
- name: manage-authorization
paths:
  /manage/services/{serviceId}/keys:
    get:
      tags:
      - manage-authorization
      summary: Retrieve service keys
      description: Retrieve service keys by service ID
      operationId: cmsGetServiceKeys
      security:
      - ManageSubscriptionKey: []
      parameters:
      - name: serviceId
        in: path
        description: ID of the service
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Service keys fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CmsSubscriptionKeys'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
    servers:
    - url: https://api.io.pagopa.it/api/v1
  /manage/services/{serviceId}/keys/{keyType}:
    put:
      tags:
      - manage-authorization
      summary: Regenerate service key
      description: Regenerate service key by service ID and key type
      operationId: cmsRegenerateServiceKey
      security:
      - ManageSubscriptionKey: []
      parameters:
      - name: serviceId
        in: path
        description: ID of the service
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/CmsSubscriptionKeyType'
      responses:
        '200':
          description: Service key regenerated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CmsSubscriptionKeys'
        '400':
          description: Invalid payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
    servers:
    - url: https://api.io.pagopa.it/api/v1
components:
  parameters:
    CmsSubscriptionKeyType:
      name: keyType
      in: path
      description: Key type
      required: true
      schema:
        type: string
        enum:
        - primary
        - secondary
  schemas:
    CmsSubscriptionKeys:
      type: object
      properties:
        primary_key:
          type: string
        secondary_key:
          type: string
      required:
      - primary_key
      - secondary_key
    ProblemJson:
      type: object
      properties:
        type:
          type: string
          format: uri
          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).'
          default: about:blank
          example: https://example.com/problem/constraint-violation
        title:
          type: string
          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'
        status:
          type: integer
          format: int32
          description: The HTTP status code generated by the origin server for this occurrence of the problem.
          minimum: 100
          example: 200
          exclusiveMaximum: 600
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.'
          example: There was an error processing the request
        instance:
          type: string
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.'
  securitySchemes:
    SubscriptionKey:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: The API key obtained through the Backoffice IO or both getService or cmsGetServiceKeys operation.
    ManageSubscriptionKey:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: The `manage` API key obtained through the Backoffice IO.
x-refined-from:
- io-functions-services.yaml
- pagopa-io-services-openapi.yml