apnf-man-platform-openapi.yaml

openapi: 3.0.3
info:
  title: APNF MAN Platform - Platform API Reference
  version: 1.9.0
  description: |
    # Introduction

    Welcome to the APNF MAN platform API reference.

    The APIs listed in this reference provide all functionalities available to service providers, including:
    - create and manage the STI certificates to be used for signing their SIP telephone calls per the STIR SHAKEN
    protocol
    - create and manage along with functionalities to manage access to the MAN platform.
    - create and manage users who shall be given access to the platform

    Each provider registered with the APNF may request an access to the MAN platform and therefore these APIs.

    ## Authentication

    All APIs listed in this document require the API client to be authenticated.
    The authentication process relies on OAuth 2.0 protocol, where an access token needs
    to be passed to the API request as a JSON Web TOKEN using the Bearer `Authorization` header.

    ```
    Authorization: Bearer <JWT>
    ```

    Refer to the *MAN Platform Authorization API Reference* on how to generate access tokens. Note that in order to
    request an access token, you will first need to create an **API credential** as described in this reference.

    ## Requests & Headers

    - A Bearer `Authorization` header is required, where the Bearer token shall be set with the access token generated by the MAN platform authorization API.
    - A `X-Request-Id` header can be provided with an uuid. If provided, this header will be returned in the
    `X-Response-Id` response header.

    ## Responses & Headers

    Unless explicitly specified, all responses will use JSON for the response body format.
    The `Content-Type` header will be included in all responses to make the type explicit.

    Following headers are also included in responses:
    - `Content-Type`: format of the response, if a body is included in the response.
    - `Content-Length`: size in bytes of the response body, if a body is included in the response.
    - `X-Response-Id`: uniquely identifies the response sent to the client. It corresponds to the `X-Request-Id`
      request header if provided. Otherwise, a new value is generated,
    - `X-Correlation-Id`: ID generated by the API gateway to track the request between the different services. This
      value can be different from the `X-Response-Id` header.

    ## Search Filters

    Several APIs support filtering through query parameters. Each filter parameter accepts operators in the format `operator:value`.

    ### Available Operators

    | Operator | Applies to | Description | Example |
    |----------|-----------|-------------|---------|
    | `eq` or none | All types | Equal (default) | `status=ACTIVE` or `status=eq:ACTIVE` |
    | `ne` | All types | Not equal | `status=ne:REVOKED` |
    | `gt` | Number, Date | Greater than | `sip_reject_code=gt:400` |
    | `gte` | Number, Date | Greater than or equal | `created_at=gte:2024-01-01T00:00:00Z` |
    | `lt` | Number, Date | Less than | `sip_reject_code=lt:500` |
    | `lte` | Number, Date | Less than or equal | `created_at=lte:2024-12-31T23:59:59Z` |
    | `gtn` | Number, Date | Null or greater than | `revoked_at=gtn:2024-01-01T00:00:00Z` |
    | `gten` | Number, Date | Null or greater than or equal | `revoked_at=gten:2024-01-01T00:00:00Z` |
    | `ltn` | Number, Date | Null or less than | `revoked_at=ltn:2024-12-31T23:59:59Z` |
    | `lten` | Number, Date | Null or less than or equal | `revoked_at=lten:2024-12-31T23:59:59Z` |
    | `match` | String | Match wildcard pattern (`*` = zero or more chars, `?` = single char) | `name=match:OPC*` |
    | `not_match` | String | Does not match pattern | `code=not_match:TEST*` |
    | `in` | All types | In a list | `status=in:[ACTIVE,REVOKED]` |
    | `not_in` | All types | Not in a list | `status=not_in:[EXPIRED,REVOKED]` |

    **Note:** Values must be percent-encoded when containing special characters.

    ## Dates

    Unless specified, all dates exposed in this API comply with the ISO-8601 date format using UTC as the timezone.

    ## Common Error Codes

    The following error codes can be returned:

    | Error code | Description                                                             |
    |:----------:|-------------------------------------------------------------------------|
    | **400**    | The request is malformed.                                               |
    | **401**    | The authentication failed.                                              |
    | **403**    | User is not allowed to access to the resource.                          |
    | **404**    | The resource does not exist.                                            |
    | **405**    | The method is not allowed for the resource.                             |
    | **406**    | The format in the `Accept` header is not supported.                     |
    | **409**    | There is a conflict between the object status and the action requested  |
    | **415**    | The format in the `Content-Type` header is not supported.               |
    | **429**    | Too many requests have been sent by the client (see Rate Limiting).      |
    | **500**    | An unexpected error occurred while processing the request.              |
    | **503**    | The service is unavailable.                                             |

    ## Rate Limiting

    To ensure availability to all clients, concurrent accesses to this API are restricted per
    below rate limiting logic:

    - Each IP address is allowed to perform up to 600 calls during a period of 1 minute.
    - The `GET /bpco/certificates` API method has an additional restriction, limiting calls to 1 per minute.
    - Any additional call will be rejected by the API using a 429 "TOO_MANY_REQUESTS" error code

    # References

    Additional API references are also available, covering other functionalities:
    - **MAN Platform Authentication API Reference**, providing the APIs to create access tokens require to authenticate against the APIs listed in this document.
    - **MAN Platform GCO API Reference**, listing the MAN platform GCO (Gestionnaires des Certificats Opérateurs) module APIs, to manage service provider data in the MAN platform, including STI certificates.
    - **MAN Platform BPCO API Reference**, listing APIs published as part of the BPCO (Base Publique des Certificats Opérateurs), the MAN platform public access service used to access STI certificates.

    # History

    **1.9.0** - 2026/06/17
    - (AUTH) Fix spelling mistake in `groups_uuid` parameter description
    - (BND) GET /delegation - Give `delegation_request_id` search criteria access to providers
    - (BND) PATCH /delegation - Add missing `delegatee_id` property in response
    - (BND) POST /delegation/revoke - Mark `revocation_requested_at` response property as required
    - (BND) GET /delegation/verify/{spc}/{tn} - Add `Cache-Control` response header
    - (BND) GET /delegation/verify/{spc}/{tn} - Update 404 & 400 errors response format
    - (BND) PATCH /delegatee/{delegatee_id} - New API to allow update of delegatees
    - (BND) POST /delegatee/{delegatee_id}/revoke - Add `revoked_at`, `revoked_by` and `revocation_origin` as optional response fields
    - (BND) `Delegatee` schema - Add `updated_at` and `updated_by` properties
    - (BND) Fix spelling mistake in TSP/OSP local copy API description
    - (GCO) Mark `renewal_auto` parameter as deprecated. Automatic renewal is now always enabled for non-test certificates.

    **1.8.0** - 2026/01/29
    - (BND) New APIs to support display delegation logic
    - (Certificates) New `ErrorCertificateValidation` error response
    - (Certificates) Provide guide for search criteria
    - (Credentials) New `perimeter` property
    - (Credentials) *MANAGER* AND *DELEGATION_MANAGER* users can now create, update and delete credentials
    - (Credentials) Provide guide for search criteria
    - (Users) `role` property replaced with `roles`
    - (Users) New roles *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR*
    - (Users) Provide guide for search criteria
    - (Users) Fix `mobile_phone` format in examples
    - (Providers) Add new `delegation_notification_list` and `delegation_ticketing_notification_list` properties for delegation notification lists
    - (Providers) Add new `delegation_near_expiration_notification_active` and `delegation_ticket_notification_active` properties for delegation notification options
    - (Providers) Add new language properties to specify the languages to use in notifications
    - (Providers) Provide guide for search criteria
    - (Providers) Add `ProviderApnfCode` schema
    - (Providers) Fix `technical_number` format in examples
    - (Tickets) Provide guide for search criteria
    - (Tickets) Replace `ID` property name with expected `id`
    - (Tickets) Review `TicketTypologyListView` schema
    - (History) Update `History` schema
    - (History) Extend possible values in `HistoryObject` property
    - (History) Add `REVOKE_INIT` action in `History` schema
    - (General) New `errors` property in `ApiPayloadError` schema
    - (General) Set `PaginationLimit` min limit to 0

    **1.7.1** - 2025/05/01
    - (Certificates) Update serial_number min size limit to 16 characters
    - (CallTraces) GET /calltraces - new query parameters `provider_disengagement`, `exclude_self_author` and `search_type`
    - (Certificates) GET /certificates - add `provider_code` property as allowed sort criteria
    - (Certificates) Add `issuer_dn` and `renewed_by` in certificate data model
    - (Meteo) Increase `long_description` maximum size for meteo event from 1000 to 5000 characters
    - (Providers) GET /providers/referential - give access to supervisor users
    - (Providers) GET /providers/referential - add technical number in CSV response
    - (Providers) GET /ticket - add `modification_date` property as allowed sort criteria
    - (Tickets) New GET /ticket/export API to export tickets
    - (Tickets) `author_ticket_internal_id` is now updatable
    - (Tickets) new properties available in data model

    **1.7.0** - 2024/09/09
    - First release
servers:
  - url: https://api.man-plateforme.fr/
    description: Production platform
  - url: https://api.pprod.man-plateforme.fr/
    description: Preproduction platform
  - url: https://api.vabf.man-plateforme.fr/
    description: VABF platform
tags:
  - name: API Credentials
    description: |
      API credentials creation and management APIs.

      API credentials are required in the API authentication process for requesting access tokens.
      Refer to the *MAN Platform Authentication API Reference* on how these credentials are used.
  - name: BPCO
    description: |
      APIs related to BPCO (Base Publique des Certificats Opérateurs), the MAN platform public access
      service to STI certificates.

      These APIs provide access to metadata and download facilities to objects
      published in the BPCO, like STI certificates and CRLs.
  - name: Call Traces
    description: |
      Call traces are provided by service providers to identity calls
      that seem legitimate to be broken due to invalid STIR SHAKEN implementation.

      These traces are accessible only to the service providers identified
      in the trace as being playing a role in the call transmission (signatory, transit, termination, etc...)
  - name: Delegatees
    description: |
      APIs for OSP service providers to create and manage delegatees.
  - name: Display Delegation Tickets
    description: |
      Tickets that can be created related to a delegation.
  - name: Display Delegations
    description: |
      APIs for OPE service providers to create and manage display delegations and OSP service providers to review display delegations granted to them.
  - name: Display Delegations Copies
    description: |
      APIs for OSP and TSP service providers to retrieve a copy of active display delagtions to initiate and maintain a local copy.
  - name: History
    description: |
      Platform activity logs access and search APIs.

      These APIs give service providers a way to have access and review actions performed by their users
      within the platform.
  - name: MAN Weather Reports
    description: |
      MAN platform weather reports can be generated by the platform itself or a service
      provider to respectively identify issues on the platform with a potential impact
      on normal operations, and issues on the service provider side leading to disengage
      the STIR-SHAKEN signature process of their calls.
  - name: Monitored SIP Interconnections
    description: |
      Creation and management APIs for SIP Interconnections between service providers.
  - name: Providers
    description: |
      Service provider registration, authorization and data management APIs.

      While most of these APIs can only be accessed by the MAN platform administrators
      to create and authorize service providers, these latter have access to a subset
      for updating their organization settings and reviewing their authorization status & history.
  - name: STI Certificates
    description: |
      STI certificates creation and management APIs.

      These APIs provide to service providers a full control of their STI certificates, with
      support of functionalities like certificate renewal, revocation and delegation.
  - name: STI Certificates (Archived)
    description: |
      STI certificates access APIs.

      3 months after their expiration, STI certificates are automatically archived by the platform
      and removed from the list of certificates. For tracking and forensics purposes, they however remain
      available for 3 years in a dedicated list, after which they are deleted
      once for all from the platform.

      These APIs just provide read-only access; no updates are allowed on certificates once archived.
  - name: Tickets
    description: |
      Tickets are created by a service provider to another provider to let
      the latter know of a potential issue of their STIR-SHAKEN implementation
      that needs to be investigated as soon as possible.

      Tickets are therefore the official communication way between service providers
      to discuss and resolve STIR-SHAKEN issues.
  - name: Users
    description: |
      User creation and management APIs.
paths:
  /delegatee:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    post:
      summary: API for the OSP to create a new delegatee for a client.
      description: |
        Create a new delegatee to be provided by the OSP service provider to its client.
        If request is completed successfully, the API returns as response the details of the newly created delegatee.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* role can create delegatees for their provider.
      operationId: CreateDelegatee
      tags:
        - Delegatees
      requestBody:
        description: Data to be associated to the new delegatee
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DelegateeCreationRequest'
      responses:
        '201':
          description: |
            Confirms the creation of the delegatee and returns its properties in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegateeCreationResponse'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when there is already an existing delegatee with the same client_internal_id.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: Delegatee already exist for '<client_internal_id>'.
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: API for the OSP to review delegatees it owns.
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can access all delegatees created by their service provider.
      operationId: SearchDelegatees
      tags:
        - Delegatees
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/DelegateeIdFilter'
        - $ref: '#/components/parameters/ClientInternalIdFilter'
        - $ref: '#/components/parameters/DelegateeStatusFilter'
        - $ref: '#/components/parameters/DelegationCntFilter'
        - $ref: '#/components/parameters/DelegateeCreatedAtFilter'
        - $ref: '#/components/parameters/DelegateeRevokedAtFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:

            The `property_name` token is one of the following values:
             - `delegatee_id`
             - `client_internal_id`
             - `status`
             - `delegation_cnt`
             - `created_at`
             - `revoked_at`

            The `order` token may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(delegatee_id|client_internal_id|status|delegation_cnt|created_at|revoked_at)$
            example: created_at:desc
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  delegatees:
                    type: array
                    items:
                      $ref: '#/components/schemas/Delegatee'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegatee/{delegatee_id}:
    parameters:
      - $ref: '#/components/parameters/DelegateeId'
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: API for the OSP to review details of a delegatee.
      description: |
        Return a JSON object with delegatee details, if a delegatee can be found with the ID passed in the request.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can access all delegatees created by their service provider.
      operationId: GetDelegatee
      tags:
        - Delegatees
      responses:
        '200':
          description: Return a JSON object with delegatee details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Delegatee'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: API for the OSP to update a delegatee.
      description: |
        This API shall be called by the OSP associated to the delegatee to be updated.

        *Notes*:
        - Only delegatees with a status 'ACTIVE' can be updated.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* role can update any delegatee created by their service provider and still active.
      operationId: UpdateDelegatee
      tags:
        - Delegatees
      requestBody:
        description: |
          Data to be updated.
          The request shall contain at least one property to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DelegateeUpdateRequest'
      responses:
        '200':
          description: |
            Confirms the update of the delegatee and returns its properties in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegateeUpdateResponse'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when there is already an existing delegatee with the same client_internal_id.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: Delegatee already exist for '<client_internal_id>'.
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegatee/{delegatee_id}/revoke:
    post:
      summary: API for the OSP to revoke a delegatee it owns.
      description: |
        API to allow an OSP to revoke a delegatee it has previously created.

        *Notes*:
        - Revoking a delegatee leads to the revocation of all active display delegations created with this delegatee.
        - Delegatees already revoked cannot be revoked again.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - Only *ADMINISTRATOR* and users with a *DELEGATION_MANAGER* role can revoke delegatees created by their service provider.
      operationId: RevokeDelegatee
      tags:
        - Delegatees
      parameters:
        - $ref: '#/components/parameters/DelegateeId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the delegatee is already revoked.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: The record is already revoked.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegatee/{delegatee_id}/history:
    parameters:
      - $ref: '#/components/parameters/DelegateeId'
      - $ref: '#/components/parameters/PaginationLimit'
      - $ref: '#/components/parameters/PaginationOffset'
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: API for the OSP to retrieve activity history on the delegatee
      description: |
        Retrieve a paginated list of all actions performed on the delegatee.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can access all delegatees created by their service provider.
      operationId: GetDelegateeHistory
      tags:
        - Delegatees
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering.
      description: |
        The API applies any sort and filter preferences passed to the API request and
        returns a paginated list of corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can access all display delegations created by their service provider.
      operationId: SearchDisplayDelegations
      tags:
        - Display Delegations
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/TnStartFilter'
        - $ref: '#/components/parameters/TnEndFilter'
        - $ref: '#/components/parameters/DelegationRequestIdFilter'
        - $ref: '#/components/parameters/ExpirationDateFilter'
        - $ref: '#/components/parameters/DelegationStatusFilter'
        - $ref: '#/components/parameters/RoleFilter'
        - $ref: '#/components/parameters/DelegationDelegateeIdFilter'
        - $ref: '#/components/parameters/OspClientInternalIdFilter'
        - $ref: '#/components/parameters/OpeInformationFilter'
        - $ref: '#/components/parameters/OspFilter'
        - $ref: '#/components/parameters/OpeFilter'
        - $ref: '#/components/parameters/DelegationCreatedAtFilter'
        - $ref: '#/components/parameters/DelegationUpdatedAtFilter'
        - $ref: '#/components/parameters/DelegationRevokedAtFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:

            The `property_name` token is one of the following values:
              - `tn_start`
              - `tn_end`
              - `delegatee_id`
              - `created_at`
              - `updated_at`
              - `expiration_date`
              - `revoked_at`

            The `order` token may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(tn_start|tn_end|delegatee_id|created_at|updated_at|expiration_date|revoked_at):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: name:asc
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  delegations:
                    type: array
                    items:
                      $ref: '#/components/schemas/DisplayDelegation'
              examples:
                DisplayDelegationSummaryListForOPE:
                  $ref: '#/components/examples/DisplayDelegationSummaryListForOPE'
                DisplayDelegationSummaryListForOSP:
                  $ref: '#/components/examples/DisplayDelegationSummaryListForOSP'
                DisplayDelegationSummaryListForAPNF:
                  $ref: '#/components/examples/DisplayDelegationSummaryListForAPNF'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: API for the OPE to create display delegations for one or more telephone numbers.
      description: |
        This API shall be called by the service provider for telephone numbers he operates as an OPE.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - Only *ADMINISTRATOR* and users with *DELEGATION_MANAGER* role can create display delegations for their provider.
      operationId: CreateDisplayDelegation
      requestBody:
        description: Creation request details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisplayDelegationCreationRequest'
      tags:
        - Display Delegations
      responses:
        '201':
          description: |
            Confirms the creation process and returns the list of the display delegations
            that have been created for the passed telephone numbers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisplayDelegationCreationResponse'
              examples:
                DisplayDelegationResponse:
                  summary: Display delegation successful creation response
                  value:
                    - tn_start: 33220102033
                      tn_end: 33220102033
                      status: ACTIVE
                      expiration_date: '2025-12-31T00:00:00Z'
                      role: OPE
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      ope_information: Lorem ipsum...
                      created_at: '2022-01-17T10:12:25Z'
                      created_by: John Doe <john.doe@spa.domain>
                      delegation_request_id: 052e12fe-bd7a-46f9-9d8d-b60f70b5733e
                    - tn_start: 33123456789
                      tn_end: 33123456900
                      status: ACTIVE
                      expiration_date: '2025-12-31T00:00:00Z'
                      role: OPE
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      ope_information: Lorem ipsum...
                      created_at: '2022-01-17T10:12:25Z'
                      created_by: John Doe <john.doe@spa.domain>
                      delegation_request_id: 052e12fe-bd7a-46f9-9d8d-b60f70b5733e
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          description: |
            Raises en error due to invalid data in the request.

            The response body contains an `error` and `message` properties
            that can be used to identify the type of validation error caught.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPayloadListError'
              examples:
                TnForbiddenDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers defined in the `tns` request property is not allowed
                  value:
                    - code: TN_FORBIDDEN
                      message: At least one number is not authorized for a display delegation. The incorrect telephone numbers are '<TNs>'.
                      errors: '`tns`: [tn1, tn2, ...]'
                TnFormatInvalidDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers defined in the `tns` request property is not allowed
                  value:
                    - code: TN_FORMAT_INVALID
                      message: The format of at least one of the numbers is invalid. The incorrect telephone numbers are '<TNs>'.
                      errors: '`tns`: [tn1, tn2, ...]'
                TnNotOwnedDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers defined in the `tns` request property is not allowed
                  value:
                    - code: TN_NOT_OWNED
                      message: The operator is not the OPE for at least one of the numbers provided. The incorrect telephone numbers are '<TNs>'.
                      errors: '`tns`: [tn1, tn2, ...]'
                DelegateeUnknownDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers defined in the `tns` request property is not allowed
                  value:
                    - code: DELEGATEE_UNKNOWN
                      message: The delegate identifier supplied does not exist in the database of known and active delegate identifiers
                      errors: '`delegatee_id`: d4f7564e-cbf6-45c3-88db-8b4df159eaf6'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when too many display delegations have been created for one of the specified telephone numbers.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: Maximum number of display delegations created for telephone number '<TN>'.
                  errors:
                    type: string
                    description: List of all invalid properties identified in the request, associated with the invalid value(s) identified in each of them
                    example: 'tns: [`tn1, tn2, ...`]'
              examples:
                DelegationAlreadyExistDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers defined in the `tns` request property already has display delegation with the same delegatee identifier. The limit of displayed telephone numbers is 100.
                  value:
                    - code: CONFLICT
                      message: A display delegation already exist with the same delegatee identifier for telephone numbers '<TNs>'.
                      errors: 'tns: [`tn1, tn2, ...`]'
                TooManyDelegationsDelegationCreationErrorResponse:
                  summary: Error raised when one of the numbers specified in the `tns` request property has reached the maximum delegation limit. The limit of displayed telephone numbers is 100.
                  value:
                    - code: TOO_MANY_DELEGATIONS
                      message: The number of display delegations has been reached for telephone numbers '<TNs>'.
                      errors: 'tns: [`tn1, tn2, ...`]'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: API for the OPE to update one or more display delegations.
      description: |
        This API shall be called by the OPE associated to the display delegations to be updated.

        *Notes*:
        - Only display delegations with a status 'ACTIVE' and for which revocation has not already been requested can be updated.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* role can update any display delegations created by their service provider and still active .
      operationId: UpdateDisplayDelegations
      tags:
        - Display Delegations
      requestBody:
        required: true
        description: |
          The request shall contain:
          - The criteria to select the display delegations to be updated:
            - The `tn_start` and `tn_end` criteria are mandatory.
            - The `delegatee_id` criteria is optional.
          - The changes to apply on `expiration_date` and/or `ope_information` properties
        content:
          application/json:
            schema:
              type: object
              required:
                - tn_start
                - tn_end
              properties:
                tn_start:
                  allOf:
                    - description: |
                        Telephone number used to define the start of the range to search for active display delegations.
                        This field is mandatory.
                    - $ref: '#/components/schemas/Tn'
                tn_end:
                  allOf:
                    - description: |
                        Telephone number used to define the end of the range to search for active display delegations.
                        This field is mandatory.
                    - $ref: '#/components/schemas/Tn'
                delegatee_id:
                  allOf:
                    - description: |
                        Optional public delegatee ID used as additional criteria to find active display delegations created
                        with this delegatee and where the calling provider is defined as the OPE.
                        When provided, it will further filter the results within the specified TN range.
                    - $ref: '#/components/schemas/DelegateeId'
                expiration_date:
                  type: string
                  description: |
                    New expiration date to apply to the display delegations found using above criteria.
                  format: date-time
                  example: '2026-01-31T10:12:25Z'
                ope_information:
                  type: string
                  maxLength: 1024
                  description: |
                    New OPE information to associate to the display delegations found using above criteria.
                  example: Lorem ipsum...
      responses:
        '200':
          description: |
            Upon successful processing, the platform returns the list of display delegations that have been effectively updated.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DisplayDelegationUpdateResponse'
              examples:
                DisplayDelegationUpdateResponse:
                  summary: Display delegation update response for a single number and a ranger of numbers
                  value:
                    - tn_start: 33220102033
                      tn_end: 33220102033
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      expiration_date: '2026-12-31T12:00:00Z'
                      ope_information: Lorem ipsum...
                    - tn_start: 33123456789
                      tn_end: 33123456900
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      expiration_date: '2026-12-31T12:00:00Z'
                      ope_information: Lorem ipsum...
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/revoke:
    post:
      summary: API for the OPE to revoke one or more display delegations.
      description: |
        This API shall be called by the OPE associated to the display delegations to be revoked.

        Upon successful processing, the corresponding display delegations will be flagged for revocation, but not immediately revoked.

        A delay of maximum 7 days is applied, to wait for potentially new display delegations to be created by the OSP client
        for the same numbers, but with a different OPE, in the case these numbers have been ported to another service provider.

        *Notes*:
        - Only display delegations with a status 'ACTIVE' and for which revocation has not already been requested can be revoked.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* role can revoke any display delegations created by their service provider and still active .
      operationId: RevokeDisplayDelegations
      tags:
        - Display Delegations
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          The request shall contain the criteria to select the display delegations to be revoked:
          - The `tn_start` and `tn_end` criteria are mandatory.
          - The `delegatee_id` criteria is optional.
        content:
          application/json:
            schema:
              type: object
              required:
                - tn_start
                - tn_end
              properties:
                tn_start:
                  allOf:
                    - description: |
                        Telephone number used to define the start of the range to search for active display delegations.
                        This field is mandatory.
                    - $ref: '#/components/schemas/Tn'
                tn_end:
                  allOf:
                    - description: |
                        Telephone number used to define the end of the range to search for active display delegations.
                        This field is mandatory.
                    - $ref: '#/components/schemas/Tn'
                delegatee_id:
                  allOf:
                    - description: |
                        Public delegatee ID used as a criteria to find all active display delegations created
                        with this delegatee and where the calling provider is defined as the OPE.
                    - $ref: '#/components/schemas/DelegateeId'
      responses:
        '200':
          description: |
            Upon successful processing, the platform returns the list of display delegations that have been flagged for revocation.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DisplayDelegationRevocationResponse'
              examples:
                DisplayDelegationRevocationResponse:
                  summary: Successful revocation request response
                  value:
                    - tn_start: 33220102033
                      tn_end: 33220102033
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      revocation_requested_at: '2025-05-12T14:15:54Z'
                    - tn_start: 33123456789
                      tn_end: 33123456900
                      delegatee_id: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
                      revocation_requested_at: '2025-05-12T14:15:54Z'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the delegation(s) status are `EXPIRED` or `REVOKED`
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: This delegation(s) status is expired or is already revoked.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/export:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: Return a csv containing a list of delegations matching the filters.
      description: |
        The API applies any sort and filter preferences passed to the API request and
        returns a paginated list of corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can export all display delegations created by their service provider.

        The results are presented in csv format with headers defined according to the user's scope:

        - **OPE**: `status;tn_start;tn_end;expiration_date;delegatee_id;ope_information;created_at;updated_at;revoked_at`
        - **OSP**: `status;tn_start;tn_end;expiration_date;delegatee_id;osp_client_internal_id;created_at;revoked_at`
      operationId: ExportDisplayDelegations
      tags:
        - Display Delegations
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/TnStartFilter'
        - $ref: '#/components/parameters/TnEndFilter'
        - $ref: '#/components/parameters/DelegationRequestIdFilter'
        - $ref: '#/components/parameters/ExpirationDateFilter'
        - $ref: '#/components/parameters/DelegationStatusFilter'
        - $ref: '#/components/parameters/RoleFilter'
        - $ref: '#/components/parameters/DelegationDelegateeIdFilter'
        - $ref: '#/components/parameters/OspClientInternalIdFilter'
        - $ref: '#/components/parameters/OpeInformationFilter'
        - $ref: '#/components/parameters/OspFilter'
        - $ref: '#/components/parameters/OpeFilter'
        - $ref: '#/components/parameters/DelegationCreatedAtFilter'
        - $ref: '#/components/parameters/DelegationUpdatedAtFilter'
        - $ref: '#/components/parameters/DelegationRevokedAtFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:

            The `property_name` token is one of the following values:
              - `tn_start`
              - `tn_end`
              - `delegatee_id`
              - `created_at`
              - `updated_at`
              - `expiration_date`
              - `revoked_at`

            The `order` token may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(tn_start|tn_end|delegatee_id|created_at|updated_at|expiration_date|revoked_at):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: name:asc
      responses:
        '200':
          description: Return a csv file containg the results
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            text/csv:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/bnd/osp:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    head:
      summary: Return date of the last change made on display delegations associated to the calling OSP.
      description: |
        This API returns the date of the last update performed on display delegations where the calling service provider
        is defined as the OSP. Changes can either be:
        - A new delegation created
        - A delegation is not active anymore, due its expiration or revocation.

        The date is returned in the `Last-Modified` response header.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can request this API.
      operationId: GetOspDisplayDelegationsLastUpdateDate
      tags:
        - Display Delegations Copies
      responses:
        '204':
          description: |
            Returns no contents. The `Last-Modified` header is set with the last update date of OSP display delegations.
          headers:
            Last-Modified:
              description: Last update date using HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticatedNoContents'
        '403':
          $ref: '#/components/responses/ErrorNoPermissionNoContents'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeaderNoContents'
        '429':
          $ref: '#/components/responses/ErrorRateLimitingNoContents'
        '500':
          $ref: '#/components/responses/ErrorInternalNoContents'
        '503':
          $ref: '#/components/responses/ServiceUnavailableNoContents'
    get:
      summary: Return the database of all active display delegations associated to the calling service provider as OSP, or changes that occurred on those delegations.
      description: |
        This method returns as a GZipped CSV file the list of all active display delegations published in the BND where the calling service provider is identified as the OSP.

        If the `since` parameter is specified, the file contains only changes made in the BND for this OSP since that date, meaning:
        - Display delegations that have been newly created with the service provider identified as the OSP
        - Display delegations where the service provider is identified as the OSP and which are not active anymore (due to revocation or expiration)

        An `If-Modified-Since` request header may also be specified. In that case, a **304** response is returned if no changes have been identified in the BND since the date specified in the header. This latter can be filled with the value of the `Last-Modified` response header collected from a previous call to this API or the `HEAD /delegation/bnd/osp` one.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can request this API.
      operationId: GetOspDisplayDelegationsCopy
      tags:
        - Display Delegations Copies
      parameters:
        - name: since
          in: query
          description: |
            Date in ISO-8601 format. When specified, return only the changes identified since that date.
            The minutes and seconds are ignored (`2022-01-17T10:12:25Z` is therefore interpreted as `2022-01-17T10:00:00Z`)
            and the date cannot be older than 15 days.
          required: false
          schema:
            type: string
            format: date-time
            example: '2025-01-19T10:00:00Z'
        - $ref: '#/components/parameters/If-Modified-Since'
      responses:
        '200':
          description: |
            Return a GZipped CSV file which includes the active display delegations where the service provider is identified as the OSP.
            Each line is composed of 2 elements:
            - A single telephone number or a range of consecutive numbers
            - The client internal ID that the OSP has provided when creating the delegatee used to create the display delegations

            ```ini
            <Single TN>;<OSP client internal ID>
            <TN Start>-<TN End>;<OSP client internal ID>
            [...]
            ```

            If the `since` parameter is present, the file contains only changes. Each line represents a change and is composed of 3 elements:
            - A single telephone number or a range of consecutive numbers
            - The client internal ID that the OSP has provided when creating the delegatee used to create the display delegations
            - The change that occurred since the date specified in the request: `CREATED` or `REMOVED`

            ```ini
            <Single TN>;<OSP client internal ID>;CREATED
            <TN Start>-<TN End>;<OSP client internal ID>;REMOVED
            ```

            A semicolon (`;`, `U+003B`) is used between each column and a linefeed is used between each line (`\n`, `U+000A`).
          content:
            application/gzip:
              schema:
                type: string
                format: binary
              examples:
                WithoutSinceParameter:
                  value: |
                    <Single TN>;<OSP client internal ID>
                    <TN Start>-<TN End>;<OSP client internal ID>
                WithSinceParameter:
                  value: |
                    <Single TN>;<OSP client internal ID>;CREATED
                    <TN Start>-<TN End>;<OSP client internal ID>;REMOVED
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Last-Modified:
              description: Date of last changes oberved on the BND. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '204':
          description: 'No Content : no change since the date provided in the `since` request parameter.'
          headers:
            Last-Modified:
              description: 'if enable : date of last changes observed on the BND. Uses HTTP-Date format (RFC 7231)'
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-GZip'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '304':
          description: No changes since the date provided in the `If-Modified-Since` request header.
          headers:
            Last-Modified:
              description: Date of last changes observed on the BND. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-GZip'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/bnd/tsp:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    head:
      summary: Return date of the last change made on display delegations in the BND.
      description: |
        This API returns the date of the last update made on all display delegations available in the BND:
        - A new delegation has been created
        - A delegation is not active anymore, due its expiration or revocation.

        The date is returned in the `Last-Modified` response header.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can request this API.
      operationId: GetDisplayDelegationLastUpdateDate
      tags:
        - Display Delegations Copies
      responses:
        '204':
          description: |
            Returns no contents. The `Last-Modified` header is set with the last update date of display delegations.
          headers:
            Last-Modified:
              description: Last update date using HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticatedNoContents'
        '403':
          $ref: '#/components/responses/ErrorNoPermissionNoContents'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeaderNoContents'
        '429':
          $ref: '#/components/responses/ErrorRateLimitingNoContents'
        '500':
          $ref: '#/components/responses/ErrorInternalNoContents'
        '503':
          $ref: '#/components/responses/ServiceUnavailableNoContents'
    get:
      summary: Return the database of all active display delegations in the BND, or changes that occurred on those delegations.
      description: |
        This method returns as a GZipped CSV file the list of all active display delegations available in the BND.

        If the `since` parameter is specified, the file contains only changes in the BND since that date, meaning:
        - Display delegations that have been newly created
        - Display delegations that are not active anymore (due to revocation or expiration)

        An `If-Modified-Since` request header may also be specified. In that case, a **304** response is returned if no changes
        have been identified in the BND since the date specified in the header. This latter can be filled with the value of the
        `Last-Modified` response header collected from a previous call to this API or the `HEAD /delegation/bnd/tsp` one.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can request this API.
      operationId: GetDisplayDelegationsCopy
      tags:
        - Display Delegations Copies
      parameters:
        - name: since
          in: query
          description: |
            Date in ISO-8601 format. When specified, return only the changes that occurred in the BND since that date.
            The minutes and seconds are ignored (`2022-01-17T10:12:25Z` is therefore interpreted as `2022-01-17T10:00:00Z`)
            and the date cannot be older than 15 days.
          required: false
          schema:
            type: string
            format: date-time
            example: '2022-01-19T10:00:00Z'
        - $ref: '#/components/parameters/If-Modified-Since'
      responses:
        '200':
          description: |
            Return a GZipped CSV file which includes all active display delegations in the BND.
            Each line is composed of 2 elements:
            - A single telephone number or a range of consecutive numbers
            - The APNF code of the service provider identified as the OSP for the active display delegations on this(ese) number(s)

            ```ini
            <Single TN>;<OSP APNF Code>
            <TN Start>-<TN End>;<OSP APNF Code>
            [...]
            ```

            If the `since` parameter is present, the file contains only changes. Each line represents a change and is composed of 3 elements:
            - A single telephone number or a range of consecutive numbers
            - The APNF code of the service provider identified as the OSP for the active display delegations on this(ese) number(s)
            - The change that occurred since the date specified in the request: `CREATED` or `REMOVED`

            ```ini
            <Single TN>;<OSP APNF Code>;CREATED
            <TN Start>-<TN End>;<OSP APNF Code>;REMOVED
            ```

            A semicolon (`;`, `U+003B`) is used between each column and a linefeed is used between each line (`\n`, `U+000A`).
          content:
            application/gzip:
              schema:
                type: string
                format: binary
              examples:
                WithoutSinceParameter:
                  value: |
                    <Single TN>;<OSP APNF Code>
                    <TN Start>-<TN End>;<OSP APNF Code>
                WithSinceParameter:
                  value: |
                    <Single TN>;<OSP APNF Code>;CREATED
                    <TN Start>-<TN End>;<OSP APNF Code>;REMOVED
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Last-Modified:
              description: Date of last changes oberved on the BND. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '204':
          description: 'No Content : no change since the date provided in the `since` request parameter.'
          headers:
            Last-Modified:
              description: 'if enable : date of last changes observed on the BND. Uses HTTP-Date format (RFC 7231)'
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-GZip'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '304':
          description: No changes since the date provided in the `If-Modified-Since` request header.
          headers:
            Last-Modified:
              description: Date of last changes observed on the BND. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-GZip'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/verify/{spc}/{tn}:
    get:
      summary: Verify if a display delegation exists for a specific telephone number and OSP
      description: |
        This method shall be called by a TSP to let it verify if a display delegation has been granted for a given OSP on a specific telephone number and is still active.

        The API returns 204 as HTTP response code if a delegation exists, 404 otherwise.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* and users with *DELEGATION_MANAGER* or *DELEGATION_SUPERVISOR* role for the DISPLAY_DELEGATION context can request this API.
      operationId: CheckDisplayDelegationExistence
      tags:
        - Display Delegations
      parameters:
        - name: spc
          in: path
          description: Service Provider Code. Each service provider in France is assigned a unique code by the APNF.
          required: true
          schema:
            type: string
            pattern: ^([0-9A-Z]{6})$
            example: OPC000
        - $ref: '#/components/parameters/Tn'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          description: |
            A display delegation exists for the telephone number and the OSP service provider and is still active.
            Returns no contents.
          headers:
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          description: |
            Raises en error due to invalid data in the request.

            The response body contains an `error` and `message` properties
            that can be used to identify the type of validation error caught.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPayloadError'
              examples:
                TnForbiddenErrorResponse:
                  summary: Error raised when the phone number is not allowed
                  value:
                    code: TN_FORBIDDEN
                    message: The number 33612345678 is not authorized for a display delegation
                    errors: '`tn`: 33612345678'
                InvalidProviderCodeErrorResponse:
                  summary: Error raised when the ProviderCode is not valid in the request
                  value:
                    code: INVALID_PROVIDER_CODE
                    message: Invalid SPC code TES01
                    errors: '`spc`: TES01'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    post:
      summary: Create a new ticket for delegation
      description: |
        Create a new ticket and notify the other provider(s) involved (notification will be sent to all mail adresses defined for the providers).

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can create new tickets.
      operationId: CreateDelegationTicket
      requestBody:
        description: Ticket details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DelegationTicketForCreation'
      tags:
        - Display Delegation Tickets
      responses:
        '201':
          description: |
            Confirms the creation of the new ticket and returns its details in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegationTicket'
              examples:
                ticket:
                  $ref: '#/components/examples/DelegationTicket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: Return a list of tickets for delegation matching the filters
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can retrieve tickets where they are involved.
      operationId: ListDelegationTicket
      tags:
        - Display Delegation Tickets
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/TicketReferenceIdFilter'
        - $ref: '#/components/parameters/TicketIssueTypeFilter'
        - $ref: '#/components/parameters/TicketAuthorInternalIdFilter'
        - $ref: '#/components/parameters/TicketStatusFilter'
        - $ref: '#/components/parameters/TicketCriticalityFilter'
        - $ref: '#/components/parameters/TicketTypologyCodeFilter'
        - $ref: '#/components/parameters/TicketNextActionRequiredByFilter'
        - $ref: '#/components/parameters/TicketProviderAuthorApnfCodeFilter'
        - $ref: '#/components/parameters/TicketCreationDateFilter'
        - $ref: '#/components/parameters/TicketModificationDateFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            * `property_name` is one of the following values:
             - `status`
             - `reference_id`
             - `issue_type`
             - `typology_code`
             - `status`
             - `criticality`
             - `provider_author_apnf_code`
             - `next_action_required_by`
             - `creation_date`
             - `modification_date`

            * `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(status|reference_id|typology_code|status|criticality|provider_author_apnf_code|next_action_required_by|creation_date|modification_date):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: start_date:asc
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  tickets:
                    type: array
                    items:
                      $ref: '#/components/schemas/DelegationTicketForList'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket/{ticket_id}:
    parameters:
      - $ref: '#/components/parameters/TicketId'
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: Return details of a ticket for delegation
      description: |
        Return a JSON object with ticket details

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can retrieve tickets where they are involved.
      operationId: GetDelegationTicket
      tags:
        - Display Delegation Tickets
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegationTicket'
              examples:
                ticket:
                  $ref: '#/components/examples/DelegationTicket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update a ticket for delegation
      description: |
        Update a ticket for delegation.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can update tickets where they are involved.
      operationId: UpdateDelegationTicket
      tags:
        - Display Delegation Tickets
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/DelegationTicketForPatch'
            examples:
              UpdateTicket:
                $ref: '#/components/examples/DelegationTicketPatch'
      responses:
        '200':
          description: Confirms successful processing and returns updated ticket in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegationTicket'
              examples:
                Meteo:
                  $ref: '#/components/examples/DelegationTicket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket/{ticket_id}/close:
    parameters:
      - $ref: '#/components/parameters/TicketId'
      - $ref: '#/components/parameters/X-Request-Id'
    post:
      summary: Close a ticket for delegation
      description: |
        Close a ticket and send a notification to all other providers involved  (notification will be sent to all mail adresses defined for the providers).

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can close tickets they have opened.
      operationId: CloseDelegationTicket
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - resolution
              properties:
                resolution:
                  $ref: '#/components/schemas/TicketResolution'
                comment:
                  type: string
                  description: a comment to be added
                  example: this ticket is fixed
      tags:
        - Display Delegation Tickets
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegationTicket'
              examples:
                ticket:
                  $ref: '#/components/examples/DelegationTicketClosed'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket/{ticket_id}/comment:
    parameters:
      - $ref: '#/components/parameters/TicketId'
      - $ref: '#/components/parameters/X-Request-Id'
    post:
      summary: Comment a ticket for delegation and send a notification
      description: |
        Adds a comment to the ticket.
        The first time the ticket is commented by the recipient provider, the status is automatically updated to "in progress"
        Sends a notification to the other involved providers  (notification will be sent to all mail adresses defined for the providers)
        Providers allowed to comment are:
        * Author provider
        * Affected provider

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can comment opened tickets they are involved in.
      operationId: CommentDelegationTicket
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - comment
              properties:
                comment:
                  type: string
                  description: the text of the comment
                  example: this is my comment
                  maxLength: 1000
      tags:
        - Display Delegation Tickets
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketComment'
              examples:
                ticket:
                  $ref: '#/components/examples/TicketComment'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: Return comments of a ticket for delegation
      description: |
        The API returns list of comments for the specified ticket.

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can retrieve comments for any tickets they are involved in.
      operationId: ListDelegationTicketComments
      tags:
        - Display Delegation Tickets
      responses:
        '200':
          description: Return a list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TicketComment'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket/export:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: return a csv containing a list of tickets matching the filters
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        The results are presented in a csv format with the following headers:
        `id;status;issue_type;typology_code;typology_criticality;typology_label;provider_author_apnf_code;next_action_required_by;creation_date;ope;osp;author_ticket_internal_id;modification_date;creation_author;modification_author;automatically_updated;description;provider_author_role;estimated_issue_date;comments(provider_author_apnf_code|creation_date|text)`

        The comments for each ticket are aggregated in the last column "comments(column provider_author_apnf_code|creation_date|text)"
          example: "WRDL00|2025-01-31T15:16:30Z|le commentaire 1|WRDL01|2025-02-01T15:16:30Z|le commentaire 2"

        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR* users can retrieve tickets where they are involved.
      operationId: ExportDelegationTickets
      tags:
        - Display Delegation Tickets
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/TicketReferenceIdFilter'
        - $ref: '#/components/parameters/TicketIssueTypeFilter'
        - $ref: '#/components/parameters/TicketAuthorInternalIdFilter'
        - $ref: '#/components/parameters/TicketStatusFilter'
        - $ref: '#/components/parameters/TicketCriticalityFilter'
        - $ref: '#/components/parameters/TicketTypologyCodeFilter'
        - $ref: '#/components/parameters/TicketNextActionRequiredByFilter'
        - $ref: '#/components/parameters/TicketProviderAuthorApnfCodeFilter'
        - $ref: '#/components/parameters/TicketCreationDateFilter'
        - $ref: '#/components/parameters/TicketModificationDateFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            * `property_name` is one of the following values:
             - `status`
             - `reference_id`
             - `issue_type`
             - `typology_code`
             - `status`
             - `criticality`
             - `provider_author_apnf_code`
             - `next_action_required_by`
             - `creation_date`
             - `modification_date`

            * `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(status|reference_id|(issue|communication)_type|criticality|provider_author_apnf_code|next_action_required_by|creation_date):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: start_date:asc
      responses:
        '200':
          description: Return a csv file containg the results
          headers:
            Content-Length:
              required: false
              description: |
                Optional. Only present when the response body size is less than 8 KB.
                For larger responses, chunked transfer encoding is used and Content-Length is not sent.
              schema:
                type: integer
                example: 80
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            text/csv:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /delegation/ticket/typology:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: Return a list of typologies for delegation
      description: |
        **Allowed Roles**: *ADMINISTRATOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*
      operationId: ListDelegationTicketTypology
      tags:
        - Display Delegation Tickets
      responses:
        '200':
          description: Return a list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TicketTypologyListView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /calltraces:
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a
        paginated list of corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any trace attached to their
          provider (as `author_provider`, `optv`, `opts`,`egress_provider`, `terminating_provider`,
          `signatory_provider` or `ingress_provider`).
      operationId: SearchTraces
      tags:
        - Call Traces
      parameters:
        - $ref: '#/components/parameters/CallTraceAuthorProviderFilter'
        - $ref: '#/components/parameters/CallTraceAuthorProviderRoleFilter'
        - $ref: '#/components/parameters/CallTraceProviderFilter'
        - $ref: '#/components/parameters/CallTraceSearchedProviderFilter'
        - $ref: '#/components/parameters/CallTraceSearchedProviderRoleFilter'
        - $ref: '#/components/parameters/CallTraceOptvFilter'
        - $ref: '#/components/parameters/CallTraceOptsFilter'
        - $ref: '#/components/parameters/CallTraceEgressProviderFilter'
        - $ref: '#/components/parameters/CallTraceTerminatingProviderFilter'
        - $ref: '#/components/parameters/CallTraceSignatoryProviderFilter'
        - $ref: '#/components/parameters/CallTraceIngressProviderFilter'
        - $ref: '#/components/parameters/CallTraceDisplayedNumberTypeFilter'
        - $ref: '#/components/parameters/CallTraceCalledNumberTypeFilter'
        - $ref: '#/components/parameters/CallTraceStartCallTimestampFilter'
        - $ref: '#/components/parameters/CallTraceBrokenCallFilter'
        - $ref: '#/components/parameters/CallTraceIdentityHeaderFilter'
        - $ref: '#/components/parameters/CallTraceSipRejectCodeFilter'
        - $ref: '#/components/parameters/CallTraceSipRejectSubcodeFilter'
        - $ref: '#/components/parameters/CallTraceAttestationFilter'
        - $ref: '#/components/parameters/CallTraceEmergencyCallFilter'
        - $ref: '#/components/parameters/CallTraceDisplayedNumberFilter'
        - $ref: '#/components/parameters/CallTracePaiFilter'
        - $ref: '#/components/parameters/CallTraceCalledNumberFilter'
        - $ref: '#/components/parameters/CallTraceProviderDisengagementFilter'
        - $ref: '#/components/parameters/CallTraceExcludeSelfAuthorFilter'
        - $ref: '#/components/parameters/CallTraceSearchTypeFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
              - `author_provider`
              - `provider`
              - `signatory_provider`
              - `start_call_timestamp`
              - `broken_call`
              - `identity_header`
              - `sip_reject_code`
              - `attestation`
              - `emergency_call`

            - `order` may be set to `asc` or `desc`.
          schema:
            example: start_call_timestamp:asc
            pattern: ^((author_|signatory_|)provider|start_call_timestamp|broken_call|identity_header|sip_reject_code|attestation|emergency_call)(:(([Aa]|[Dd][Ee])[Ss][Cc]))?$
            type: string
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  traces:
                    items:
                      $ref: '#/components/schemas/TraceSummaryView'
                    type: array
                type: object
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /calltraces/{trace_id}:
    get:
      summary: Return traces details
      description: |
        Return a JSON object with trace details.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any trace attached to their provider.
      operationId: GetTrace
      tags:
        - Call Traces
      parameters:
        - in: path
          name: trace_id
          description: ID of the trace.
          required: true
          schema:
            $ref: '#/components/schemas/TraceId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with trace properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Trace'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ism:
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnections attached to their provider.
      operationId: SearchIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - $ref: '#/components/parameters/IsmProviderEmitterCodeFilter'
        - $ref: '#/components/parameters/IsmProviderEmitterStatusFilter'
        - $ref: '#/components/parameters/IsmProviderReceiverCodeFilter'
        - $ref: '#/components/parameters/IsmProviderReceiverStatusFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  interconnections:
                    type: array
                    items:
                      $ref: '#/components/schemas/ISMSummaryView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Initiate the creation of a monitored SIP interconnection
      description: |
        Initiate the creation of a new monitored SIP interconnection. Shall always be called by the provider emitter of the interconnection.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*
      operationId: CreateIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: ISM details
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - provider_emitter_status
                - provider_receiver_code
                - provider_receiver_status
              properties:
                provider_emitter_status:
                  type: string
                  description: |
                    The status of the provider emitter
                  example: FULL MAN
                provider_receiver_code:
                  type: string
                  description: |
                    The code of the provider receiver
                  pattern: ^([0-9A-Z]{6})$
                  example: SPB000
                provider_receiver_status:
                  type: string
                  description: |
                    Default value = "NOT MAN"
                    - Can be set if the status of the emitting provider is different from "NOT MAN"
                  example: FULL MAN
                interconnection_description:
                  type: string
                  description: |
                    Change the description of the interconnection
                  example: Une nouvelle description
      responses:
        '201':
          description: Confirms the creation of the new monitored SIP interconnection properties and contents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISMSummaryView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ism/export:
    get:
      summary: Return monitored SIP interconnections list in CSV format
      description: |
        Allows you to return, in CSV format, the list of monitored interconnections

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnection attached to their provider.
      operationId: ExportIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return monitored SIP interconnections list in csv format
          content:
            text/csv:
              example: |
                ID;provider_emitter_code;provider_emitter_status;date_last_update_emitter;provider_receiver_code;provider_receiver_status;date_last_update_receiver;creation_date;interconnection_description
                2f211b73-4a09-9830-b6e4-064f39399c36;GAMMA0;PARTIAL_MAN;2023-05-24T09:39:44;GAMMA1;NOT_MAN;2023-05-24T09:39:44;2023-05-24T09:39:44;Description
              schema:
                type: string
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ism/{ism_id}:
    delete:
      summary: Delete monitored SIP interconnection
      description: |
        *Warning*: the action cannot be undone.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* users can delete any monitored SIP interconnection attached to their provider and by a provider emitter.
      operationId: DeleteIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - name: ism_id
          in: path
          description: ID of the interconnection.
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          description: Confirms successful processing
          headers:
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
    get:
      summary: Return monitored SIP interconnection details
      description: |
        Return a JSON object with monitored SIP interconnection details and contents.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any monitored SIP interconnection attached to their provider.
      operationId: GetIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - name: ism_id
          in: path
          description: ID of the interconnection.
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with monitored SIP interconnection properties and contents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISMSummaryView'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update interconnection properties
      description: |
        Update interconnection properties. Only a subset of the interconnection properties can be updated and depending on the status of the provider's interconnection.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can update any interconnection created by/for their provider.
      operationId: UpdateIsm
      tags:
        - Monitored SIP Interconnections
      parameters:
        - name: ism_id
          in: path
          description: ID of the interconnection.
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                provider_emitter_status:
                  type: string
                  description: |
                    Change the status of the provider emitter
                    - Can only be changed by the provider emitter
                  example: FULL MAN
                provider_receiver_status:
                  type: string
                  description: |
                    Change the status of the provider receiver
                    - Can only be changed by the provider receiver if the status of the emitting provider is different from "Non MAN"
                  example: FULL MAN
                interconnection_description:
                  type: string
                  description: |
                    Change the description of the interconnection
                  example: Une nouvelle description
      responses:
        '200':
          description: Return the JSON object with monitored SIP interconnection properties and contents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ISMSummaryView'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /meteo:
    get:
      summary: Return a list of meteo events matching the filters
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - Anyone with access to the interface can read the events
      operationId: ListMeteos
      tags:
        - MAN Weather Reports
      parameters:
        - $ref: '#/components/parameters/MeteoCriticalityFilter'
        - $ref: '#/components/parameters/MeteoTagsFilter'
        - $ref: '#/components/parameters/MeteoStartDateFilter'
        - $ref: '#/components/parameters/MeteoEndDateFilter'
        - $ref: '#/components/parameters/MeteoProviderAuthorApnfCodeFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            * `property_name` is one of the following values:
             - `criticality`
             - `start_date`
             - `end_date`
             - `provider_author_apnf_code`

            * `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(criticality|(start|end)_date|provider_author_apnf_code):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: start_date:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  meteos:
                    type: array
                    items:
                      $ref: '#/components/schemas/Meteo'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Create a new meteo event
      description: |
        Create a new event.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - Any user can create new events.
        - *MANAGER* and *SUPERVISOR* users can only create MAN bypass events (*tags*: `DISENGAGEMENT`)
        - *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can only create events related to display delegations (*tags*: `DELEGATION`)
        - *ADMINISTRATOR* users can create both MAN bypass events (*tags*: `DISENGAGEMENT`) and events related to display delegations (*tags*: `DELEGATION`)
      operationId: CreateMeteo
      tags:
        - MAN Weather Reports
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: Meteo event details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeteoForCreation'
      responses:
        '201':
          description: |
            Confirms the creation of the new event and returns its details in the response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Meteo'
              examples:
                ticket:
                  $ref: '#/components/examples/MeteoCreation'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /meteo/{meteo_id}:
    get:
      summary: Return details of a meteo event
      description: |
        Return a JSON object with meteo event details
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - Any user can read the events
      operationId: GetMeteo
      tags:
        - MAN Weather Reports
      parameters:
        - name: meteo_id
          in: path
          description: reference id to the meteo (integer).
          required: true
          schema:
            type: integer
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Meteo'
              examples:
                ticket:
                  $ref: '#/components/examples/Meteo'
                ticket_disengagement:
                  $ref: '#/components/examples/MeteoDisengagement'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update a meteo event
      description: |
        Update a meteo event, for example to add an end date
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *MANAGER* and *SUPERVISOR* users can only update MAN bypass events created by their provider (*tags*: `DISENGAGEMENT`)
        - *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can only update events related to display delegations created by their provider (*tags*: `DELEGATION`)
        - *ADMINISTRATOR* users can update both MAN bypass events (*tags*: `DISENGAGEMENT`) and events related to display delegations (*tags*: `DELEGATION`) created by their provider.
      operationId: UpdateMeteo
      tags:
        - MAN Weather Reports
      parameters:
        - name: meteo_id
          in: path
          description: reference id to the meteo (integer).
          required: true
          schema:
            type: integer
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/MeteoPatch'
            examples:
              UpdateMeteo:
                $ref: '#/components/examples/MeteoPatch'
      responses:
        '200':
          description: Confirms successful processing and returns updated event in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Meteo'
              examples:
                Meteo:
                  $ref: '#/components/examples/Meteo'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/referential:
    get:
      summary: Retrieve a listing of all service providers in .csv format.
      description: |
        Provides listing of both MAN and non-MAN service providers in .csv format.

        The file contains the following items for each provider, with headers at first line:
          - ARCEP code (string)
          - APNF code as (string)
          - a label related to the provider (string)
          - whether or not the provider subscribed to MAN (boolean)

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: GetProvidersReferential
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return providers's informations in csv format.
          content:
            text/csv:
              schema:
                type: string
              example: |
                arcep_code;apnf_code;label;subscription;technical_number
                GAMMA0;GAMMA0;Provider Label;true;+33102030405
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/{provider_id}:
    get:
      summary: Return provider details
      description: |
        Return a JSON object with provider details.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can only access details of their provider.
      operationId: GetProvider
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a JSON object with provider details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Provider'
              examples:
                Provider Details:
                  $ref: '#/components/examples/ProviderDetails'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update provider properties
      description: |
        Update provider properties. Deleted providers cannot be updated.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* users can update properties of their own provider. Only a subset of the provider properties can be updated by these users.
      operationId: UpdateProvider
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: |
                    Change the provider status. Only possible values are `ENABLED` and `DISABLED`.
                    - Only *MAN_ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                  enum:
                    - ENABLED
                    - DISABLED
                name:
                  type: string
                  maxLength: 64
                  description: |
                    Change the provider name
                    - Only *MAN_ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                  example: Opérateur
                address:
                  type: string
                  maxLength: 255
                  description: |
                    Change the provider HQ address
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                  example: 30, rue de Paris 75018 Paris
                technical_number:
                  type: string
                  maxLength: 15
                  description: |
                    Change the provider technical phone number
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                signatory:
                  type: boolean
                  description: |
                    Change the provider signatory flag
                    - Only *MAN_ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                  default: true
                opts:
                  type: string
                  description: |
                    Change the provider opts flag
                    - Only *MAN_ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                opts_contracts:
                  type: array
                  description: |
                    Change the list of providers allowed to select this provider as OPTS.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR*, *MANAGER* and *APNF* users can update this property
                    - Can be deleted.
                  items:
                    $ref: '#/components/schemas/ProviderCode'
                legal_administrator:
                  allOf:
                    - description: |
                        UUID of the user account to change the provider legal administrator
                    - $ref: '#/components/schemas/UUID'
                global_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'global' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                legal_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'legal' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                certificate_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'certificate' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                delegation_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'delegation' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                delegation_ticketing_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'delegation ticketing' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                ticketing_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'ticketing' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                deposit_notification_list:
                  description: |
                    Change the list of email addresses for the provider 'deposit' notification list.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: array
                  items:
                    $ref: '#/components/schemas/EmailAddress'
                delegation_near_expiration_notification_active:
                  description: |
                    Change the flag to receive delegation near expiration notifications.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: boolean
                  example: true
                delegation_ticket_notification_active:
                  description: |
                    Change the flag to receive delegation expire notifications.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: boolean
                  example: true
                ticket_notification_active:
                  description: |
                    Change the flag to receive ticket notifications.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Can be deleted.
                  type: boolean
                  example: true
                sftp_allowed_keys:
                  type: array
                  description: |
                    Change the SSH public keys allowed to access the platform SFTP service created for the provider.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - All values shall be passed when updating the property
                    - Can be deleted.
                  items:
                    type: string
                    maxLength: 1024
                    description: SSH public key contents
                    example: ssh-rsa AAAAB3NzaC...p5CSsDJ SI@host-4527
                sftp_allowed_ips:
                  type: array
                  description: |
                    Change the list of IPv4 addresses to be allowed to connect to the SFTP BSM service.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - All values shall be passed when updating the property
                    - Can be deleted.
                  items:
                    type: string
                    description: IPv4 address
                    format: ipv4
                    pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.){3}(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)$
                    example: 127.0.0.1
                languages:
                  type: array
                  description: |
                    Change the list of languages to be proposed to the provider users for the platform UI.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - All values shall be passed when updating the property
                    - Cannot be deleted.
                  items:
                    $ref: '#/components/schemas/Language'
                  example:
                    - FRENCH
                    - ENGLISH
                authentication_mode:
                  type: string
                  description: |
                    Change the mode to be used to authenticate provider user accounts.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - Cannot be deleted.
                  enum:
                    - SSO
                    - MFA
                  default: MFA
                  example: SSO
                sso_settings:
                  type: object
                  description: |
                    Change the Single Sign-On configuration.
                    - *MAN_ADMINISTRATOR*, *ADMINISTRATOR* and *APNF* users can update this property
                    - To be used only when `authentication_mode` is set to `SSO`.
                    - All values shall be passed when updating the property
                default_notification_language:
                  $ref: '#/components/schemas/LanguageForNotificationsByDefault'
                global_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                certificate_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                deposit_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                legal_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                ticketing_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                delegation_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
                delegation_ticketing_notification_list_language:
                  $ref: '#/components/schemas/LanguageForNotifications'
            examples:
              ProviderUpdateRequestByManAdministrator:
                $ref: '#/components/examples/ProviderUpdateRequestByManAdministrator'
              ProviderUpdateRequestByAdministrator:
                $ref: '#/components/examples/ProviderUpdateRequestByAdministrator'
      responses:
        '200':
          description: Confirms successful processing and return the provider properties in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Provider'
              examples:
                Successful response with provider properties:
                  $ref: '#/components/examples/ProviderDetails'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/{provider_id}/bypass_token:
    get:
      summary: Retrieve a paginated list of bypass tokens created for the provider.
      description: |
        The API applies any sort preferences passed to the API request and returns a paginated list of corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: ListProviderBypassTokens
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a list of bypass tokens
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  bypass_tokens:
                    type: array
                    items:
                      $ref: '#/components/schemas/BypassToken'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Generate new provider bypass token
      description: |
        Create a new provider bypass token. The previous token will be archived.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR*, *MANAGER* can generate bypass token for their own provider.
      operationId: GenerateProviderBypassToken
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a JSON object with a single `id` property containing the bypass token value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BypassTokenCreationResponse'
              examples:
                Successful response with bypass token details:
                  $ref: '#/components/examples/BypassTokenCreationResponse'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/{provider_id}/history:
    get:
      summary: Retrieve activity history on the provider
      description: |
        Retrieve a paginated list of all actions performed on the provider.
        Sorting and filtering are not supported for this API.


        **Allowed Roles**: *ADMINISTRATOR*

        - *ADMINISTRATOR* can only access the history of its own provider.
      operationId: GetProviderHistory
      tags:
        - History
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/{provider_id}/verification:
    get:
      summary: Return the details for a provider verification
      description: |
        Return the details for a provider verification

        **Allowed Roles**: *ADMINISTRATOR*

        - *ADMINISTRATOR* users can view their own provider verification.
      operationId: GetProviderVerification
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the provider verification details
          content:
            application/json:
              schema:
                description: |
                  Provider authorization status.
                  A provider shall be authorized in order to request the generation of certificates.
                  Once authorized, a provider shall also be authorized back each year.
                properties:
                  appointments:
                    description: When the meeting can be scheduled
                    items:
                      type: string
                      format: date-time
                    maxItems: 3
                    minItems: 3
                    type: array
                  contact:
                    $ref: '#/components/schemas/ProviderVerificationContact'
                  date_next_validation_meeting:
                    description: When the meeting is scheduled
                    format: date-time
                    type: string
                  details:
                    description: What details were verified
                    properties:
                      contact_email_verified:
                        description: Whether or not the administrator mail was verified
                        type: boolean
                      contact_identity_verified:
                        description: Whether or not the administrator identity was verified
                        type: boolean
                      contact_phone_verified:
                        description: Whether or not the administrator phone was verified
                        type: boolean
                      global_notification_list_verified:
                        description: Whether or not the global mailing list was verified
                        type: boolean
                      legal_notification_list_verified:
                        description: Whether or not the legal mailing list was verified
                        type: boolean
                      provider_address_verified:
                        description: Whether or not the provider address was verified
                        type: boolean
                      provider_name_verified:
                        description: Whether or not the provider name was verified
                        type: boolean
                  provider:
                    type: object
                    properties:
                      address:
                        description: the physical address of the provider
                        type: string
                      code:
                        allOf:
                          - description: APNF code of the provider
                          - $ref: '#/components/schemas/ProviderCode'
                      global_notification_list:
                        items:
                          $ref: '#/components/schemas/EmailAddress'
                        minItems: 1
                        type: array
                      id:
                        allOf:
                          - description: ID of the provider
                          - $ref: '#/components/schemas/UUID'
                      legal_notification_list:
                        items:
                          $ref: '#/components/schemas/EmailAddress'
                        minItems: 1
                        type: array
                      name:
                        description: Name of the provider
                        type: string
                      status:
                        allOf:
                          - description: Status of the provider
                          - $ref: '#/components/schemas/ProviderStatus'
                    required:
                      - address
                      - code
                      - global_notification_list
                      - id
                      - legal_notification_list
                      - name
                      - status
                  secret:
                    allOf:
                      - $ref: '#/components/schemas/ProviderVerificationSecret'
                      - description: The shared secret as proof of verification (MAN_VALIDATOR)
                  status:
                    description: Status of the verification
                    enum:
                      - HOLD
                      - TO_SCHEDULE
                      - SCHEDULED
                      - VALIDATED
                      - DOUBTFUL
                    type: string
                  ticket_number:
                    description: The ticket number from NSDC when the provider sent his appointments
                    type: integer
                  valid_until:
                    description: When the provider must be verified before
                    type: string
                    format: date-time
                required:
                  - provider
                  - status
                type: object
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /providers/{provider_id}/verification/appointments:
    post:
      summary: Set appointments for a provider verification
      description: |
        Set appointments for a provider verification

        **Allowed Roles**: *ADMINISTRATOR*
      operationId: UpdateProviderVerificationAppointmentsStep
      tags:
        - Providers
      parameters:
        - $ref: '#/components/parameters/ProviderId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                appointments:
                  description: When the meeting can be scheduled
                  items:
                    format: date-time
                    type: string
                  maxItems: 3
                  minItems: 3
                  type: array
                contact:
                  $ref: '#/components/schemas/ProviderVerificationContact'
              required:
                - appointments
                - contact
              type: object
        description: Data to be set suggesting appointments for the provider verification
        required: true
  /users:
    post:
      summary: Create a new user
      description: |
        Create a new user account.

        **Allowed Roles**: *ADMINISTRATOR*

        - *ADMINISTRATOR* users can create *MANAGER* and *SUPERVISOR* accounts associated to their own provider.
      operationId: CreateUser
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: Data to be set for the new user
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreationRequest'
            examples:
              UserCreationRequestByManAdministrator:
                $ref: '#/components/examples/UserCreationRequestByManAdministrator'
              ProviderUserCreationRequestByManAdministrator:
                $ref: '#/components/examples/ProviderUserCreationRequestByManAdministrator'
              ProviderUserCreationRequestByAdministrator:
                $ref: '#/components/examples/ProviderUserCreationRequestByAdministrator'
      responses:
        '201':
          description: |
            Confirms the creation of the account and returns its properties in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                ApnfUserCreationResponse:
                  $ref: '#/components/examples/ApnfUserCreationResponse'
                ProviderUserCreationResponse:
                  $ref: '#/components/examples/ProviderUserCreationResponse'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - Provider users can access any user of their provider.
      operationId: SearchUsers
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserIdFilter'
        - $ref: '#/components/parameters/UserProviderIdFilter'
        - $ref: '#/components/parameters/UserFirstnameFilter'
        - $ref: '#/components/parameters/UserLastnameFilter'
        - $ref: '#/components/parameters/UserEmailAddressFilter'
        - $ref: '#/components/parameters/UserLanguageFilter'
        - $ref: '#/components/parameters/UserRolesFilter'
        - $ref: '#/components/parameters/UserStatusFilter'
        - $ref: '#/components/parameters/UserDeletedFilter'
        - $ref: '#/components/parameters/UserLastConnectedAtFilter'
        - $ref: '#/components/parameters/UserCreatedAtFilter'
        - $ref: '#/components/parameters/UserUpdatedAtFilter'
        - $ref: '#/components/parameters/UserDeletedAtFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
             - `id`
             - `provider_id` (only for *MAN_ADMINISTRATOR* and *APNF* users)
             - `firstname`
             - `lastname`
             - `email_address`
             - `roles`
             - `status`
             - `last_connected_at`
             - `created_at`
             - `updated_at`
             - `deleted_at`

            - `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(id|provider_id|(first|last)name|email_address|mobile_phone|language|roles|status|deleted|last_connected_at|(crea|upda|dele)ted_(at|by)):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: firstname:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserSummaryView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /users/{user_id}:
    get:
      summary: Return user details
      description: |
        Return a JSON object with user details.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can access any user belonging to their provider.
      operationId: GetUser
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a JSON object with user details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                ProviderUser:
                  $ref: '#/components/examples/ProviderUser'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update user properties
      description: |
        Update user properties. Deleted users cannot be updated.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* users can update properties of all accounts belonging to their provider.
        - In all cases, when editing its own account, a user is limited to a subset of properties.
      operationId: UpdateUser
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value). No properties can be deleted.
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                firstname:
                  type: string
                  maxLength: 64
                  description: |
                    Change the user first name
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  example: Jane
                lastname:
                  type: string
                  maxLength: 64
                  description: |
                    Change the user last name
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  example: Doe
                email_address:
                  type: string
                  maxLength: 254
                  format: email
                  description: |
                    Change the user email address
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  example: jane.doe@my.company
                mobile_phone:
                  type: string
                  maxLength: 20
                  description: |
                    Change the user mobile phone number
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  example: '06123456789'
                language:
                  allOf:
                    - $ref: '#/components/schemas/Language'
                    - description: |
                        Change the user language preference
                        - A user can update this property for its own account
                        - The list of languages available to the user depends on the provider configuration.
                        - Cannot be deleted.
                roles:
                  type: array
                  items:
                    $ref: '#/components/schemas/UserRole'
                  description: |
                    Change the user role
                    - A user cannot update this property for its own account
                    - Can be updated by ADMINISTRATOR users for accounts belonging to their provider
                    - Can be updated by MAN_ADMINISTRATOR users for MAN_ADMINISTRATOR and APNF accounts. Can also update provider MANAGER or SUPERVISOR users to ADMINISTRATOR.
                    - Cannot be deleted.
                status:
                  type: string
                  description: |
                    Change the user status. Only possible values are `ENABLED` and `DISABLED`.
                    - A user cannot update this property for its own account
                    - Can be updated by ADMINISTRATOR users for accounts belonging to their provider
                    - Can be updated by MAN_ADMINISTRATOR users for MAN_ADMINISTRATOR and APNF accounts
                    - Cannot be deleted.
                  enum:
                    - ENABLED
                    - DISABLED
            examples:
              UserPersonalUpdateRequest:
                $ref: '#/components/examples/UserPersonalUpdateRequest'
              UserUpdateRequest:
                $ref: '#/components/examples/UserUpdateRequest'
      responses:
        '200':
          description: Confirms successful processing and return the user properties in the response.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                ProviderUser:
                  $ref: '#/components/examples/ProviderUser'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the user is deleted.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: The user is deleted.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    delete:
      summary: Delete a user
      description: |
        Once deleted, the user will not anymore be able to access the platform.

        Note this is a soft-delete operation; the user will be effectively removed after 3 months,
        and during that period a rollback of the delete action is possible using the `POST /users/{user_id}/undelete`
        API.

        **Allowed Roles**: *ADMINISTRATOR*

        - *ADMINISTRATOR* users can delete any user belonging to their provider, except their own account.
      operationId: DeleteUser
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /users/reset-credential:
    post:
      summary: Request for new user account password or otp
      description: |
        This API triggers a user account password, OTP reset process or new account activation link, where an email is sent to the email
        address specified by the user at the origin of the request in order to access a page to
        specify a new password or OTP or also enable his account.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR* users can request a new password for accounts belonging to their provider.
        - Otherwise, can be called by any user when they have forgotten their password
      operationId: ResetUserCredential
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  allOf:
                    - description: |
                        ID of the user to reset the password.
                        Can be used only by a ADMINISTRATOR user.
                    - $ref: '#/components/schemas/UUID'
                email_address:
                  description: |
                    Email address of the user to reset the password.
                  type: string
                  maxLength: 254
                  example: john.doe@spa.domain
                otp:
                  description: |
                    (optional) Boolean to precise if OTP is to renew. If value is not provided or false, password will be renewed.
                  type: boolean
            examples:
              PasswordResetRequestUsingEmailAddress:
                $ref: '#/components/examples/PasswordResetRequestUsingEmailAddress'
              OtpResetRequestUsingEmailAddress:
                $ref: '#/components/examples/OtpResetRequestUsingEmailAddress'
              PasswordResetRequestUsingUserId:
                $ref: '#/components/examples/PasswordResetRequestUsingUserId'
              ResendActivationLinkRequestUsingUserId:
                $ref: '#/components/examples/ResendActivationLinkRequestUsingUserId'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          $ref: '#/components/responses/ErrorConflict'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /users/{user_id}/history:
    get:
      summary: Retrieve activity history on users
      description: |
        Retrieve a paginated list of all actions performed on a user.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*,  *SUPERVISOR* and *DELEGATION_SUPERVISOR* users can access the history of any user of their provider.
        - *MANAGER* and *DELEGATION_MANAGER* users can only access the history of its own provider.
      operationId: GetUserHistory
      tags:
        - History
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /users/{user_id}/undelete:
    post:
      summary: Cancel user deletion
      description: |
        Rollback the deletion action performed on a user.
        Upon successful processing, user will have access back to the platform.

        **Allowed Roles**: *ADMINISTRATOR*

        - *ADMINISTRATOR* users can call this API for any user of their provider, except their own account.
      operationId: UndeleteUser
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /users/{user_id}/preferences:
    get:
      summary: Return portal preferences of the user
      description: |
        Return portal preferences of the user.
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*
      operationId: GetUserPref
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a JSON object with user preferences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPref'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update portal preferences of the user
      description: |
        Update portal preferences of the user.
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*
      operationId: UpdateUserPref
      tags:
        - Users
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value). No properties can be deleted.
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                pagination_limit:
                  type: integer
                  description: |
                    Default number of resources per page
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  minimum: 1
                  default: 20
                  maximum: 100
                show_menu:
                  type: boolean
                  description: |
                    Default menu visibility
                    - A user can update this property for its own account
                    - Cannot be deleted.
                  default: true
      responses:
        '200':
          description: Confirms successful processing and return the portal preferences of the user in the response.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPref'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the user is deleted.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: The user is deleted.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket:
    get:
      summary: Return a list of STI certificates related tickets matching the filters
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*: can retrieve tickets where they are involved.
      operationId: ListTickets
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketStatusFilter'
        - $ref: '#/components/parameters/TicketReferenceIdFilter'
        - $ref: '#/components/parameters/TicketIssueTypeFilter'
        - $ref: '#/components/parameters/TicketCommunicationTypeFilter'
        - $ref: '#/components/parameters/TicketCriticalityFilter'
        - $ref: '#/components/parameters/TicketProviderAuthorApnfCodeFilter'
        - $ref: '#/components/parameters/TicketNextActionRequiredByFilter'
        - $ref: '#/components/parameters/TicketCreationDateFilter'
        - $ref: '#/components/parameters/TicketTypologyCodeFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            * `property_name` is one of the following values:
             - `status`
             - `reference_id`
             - `issue_type`
             - `communication_type`
             - `criticality`
             - `provider_author_apnf_code`
             - `next_action_required_by`
             - `creation_date`
             - `modification_date`

            * `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(status|reference_id|(issue|communication)_type|criticality|provider_author_apnf_code|next_action_required_by|(creation|modification)_date):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: start_date:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  tickets:
                    type: array
                    items:
                      $ref: '#/components/schemas/TicketSummary'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Create a new STI certificates related ticket
      description: |
        Create a new STI certificates related ticket and notify the other provider(s) involved (notification will be sent to all email addresses defined for the providers).

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: CreateTicket
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: Ticket details
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketForCreation'
      responses:
        '201':
          description: |
            Confirms the creation of the new event and returns its details in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
              examples:
                ticket:
                  $ref: '#/components/examples/Ticket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket/typology:
    get:
      summary: Return a list of typologies for STI certificates related tickets
      description: |
        Return the full list of possible typologies that can be associated to a STI certificates related ticket.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: ListTicketTypologies
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TicketTypologyListView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket/{ticket_id}:
    get:
      summary: Return details of a STI certificates relatedticket
      description: |
        Return a JSON object with ticket details.
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*: can retrieve tickets where they are involved.
      operationId: GetTicket
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
              examples:
                ticket:
                  $ref: '#/components/examples/Ticket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update a STI certificates related ticket
      description: |
        Update a STI certificates related ticket, for example to add a new involved provider

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*: can update tickets where they are involved.
      operationId: UpdateTicket
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/TicketPatch'
            examples:
              UpdateTicket:
                $ref: '#/components/examples/TicketPatch'
      responses:
        '200':
          description: Confirms successful processing and returns updated ticket in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
              examples:
                Meteo:
                  $ref: '#/components/examples/Ticket'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket/{ticket_id}/close:
    post:
      summary: Close a STI certificates related ticket
      description: |
        Close a STI certificates related ticket and send a notofication to all other providers involved (notification will be sent to all email addresses defined for the providers).
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can close tickets they have opened.
      operationId: CloseTicket
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - resolution
              properties:
                resolution:
                  $ref: '#/components/schemas/TicketResolution'
                comment:
                  type: string
                  description: a comment to be added
                  example: this ticket is fixed
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ticket'
              examples:
                ticket:
                  $ref: '#/components/examples/TicketClosed'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket/{ticket_id}/comment:
    get:
      summary: Return the comments for a STI certificates related ticket
      description: |
        Return the full list of comments made on a STI certificates related ticket.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR* can retrieve comments for any STI certificates related ticket their provider is involved in.
      operationId: ListTicketComments
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TicketComment'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Comment a ticket and send a notification.
      description: |
        Adds a comment to the ticket.
        The first time the ticket is commented by the recipient provider, the status is automatically updated to "in progress"
        Sends a notification to the other involved providers (notification will be sent to all email addresses defined for the providers)
        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR* users can comment tickets they are involved in.
      operationId: CommentTicket
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - comment
              properties:
                comment:
                  type: string
                  description: the text of the comment
                  example: this is my comment
                  maxLength: 500
      responses:
        '200':
          description: Return the JSON object with ticket details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketComment'
              examples:
                ticket:
                  $ref: '#/components/examples/TicketComment'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /ticket/export:
    parameters:
      - $ref: '#/components/parameters/X-Request-Id'
    get:
      summary: return a csv containing a list of tickets matching the filters
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        The results are presented in a csv format with the following headers:
          id;status;issue_type;communication_type;typology_category;typology_code;typology_criticality;typology_label;provider_author_apnf_code;next_action_required_by;creation_date;signatory;emitter;terminationVoice;opts;optv;ingress;terminationMessage;author_ticket_internal_id;modification_author_apnf_code;modification_date;creation_author;modification_author;automatically_updated;description;source;number_of_communications;provider_author_role;called_number;communication_timestamp;is_recurring_issue;is_related_to_single_called_customer;estimated_issue_date;other_nonprovider_actor;message_type;displayed_identifier;issuer_id;egress;display_number;display_number_type;has_identity_header;is_sti_vs_val;shaken_attestation_value;last_known_interconnection;sip_reject_code;sip_reject_subcode;is_emergency_call;calling_number;is_call_breakable;is_call_broken;comments(provider_author_apnf_code|creation_date|text)

        The comments for each ticket are aggregated in the last column "comments(column provider_author_apnf_code|creation_date|text)"
          example: "WRDL00|2025-01-31T15:16:30Z|le commentaire 1|WRDL01|2025-02-01T15:16:30Z|le commentaire 2"

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        * *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can retrieve tickets where they are involved.
      operationId: ExportTickets
      tags:
        - Tickets
      parameters:
        - $ref: '#/components/parameters/TicketStatusFilter'
        - $ref: '#/components/parameters/TicketReferenceIdFilter'
        - $ref: '#/components/parameters/TicketIssueTypeFilter'
        - $ref: '#/components/parameters/TicketCommunicationTypeFilter'
        - $ref: '#/components/parameters/TicketCriticalityFilter'
        - $ref: '#/components/parameters/TicketProviderAuthorApnfCodeFilter'
        - $ref: '#/components/parameters/TicketNextActionRequiredByFilter'
        - $ref: '#/components/parameters/TicketCreationDateFilter'
        - $ref: '#/components/parameters/TicketTypologyCodeFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            * `property_name` is one of the following values:
             - `status`
             - `reference_id`
             - `issue_type`
             - `communication_type`
             - `criticality`
             - `provider_author_apnf_code`
             - `next_action_required_by`
             - `creation_date`

            * `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(status|reference_id|(issue|communication)_type|criticality|provider_author_apnf_code|next_action_required_by|creation_date):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: start_date:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a csv file containg the results
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            text/csv:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /credentials:
    post:
      summary: Create a new API credential
      description: |
        This credential contains the `client_id` and `client_secret` information to be used in the MAN platform
        authorization API call required to deliver access tokens.

        *Warning:* The `client_secret` property is only provided in the response and cannot be retrieved afterward.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* users can create API credential with any perimeter for their provider.
        - *MANAGER* users can only create API credentials with CALL_AUTHENTICATION perimeter for their provider.
        - *DELEGATION_MANAGER* users can only create API credentials with DISPLAY_DELEGATION perimeter for their provider.
      operationId: CreateApiCredential
      tags:
        - API Credentials
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: Data to be set for the new API credential
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCredentialCreationRequest'
      responses:
        '201':
          description: |
            Confirms the creation of the new API credential and returns its properties in the response.

            *Warning* This is the only time the `client_secret` property is provided.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCredentialCreationResponse'
              examples:
                ApiCredentialWithSecret:
                  $ref: '#/components/examples/ApiCredentialCreationResponse'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, users can access any credential attached to their provider.
        - *MANAGER* and *SUPERVISOR* users can access any credential attached to their provider and with a CALL_AUTHENTICATION perimeter.
        - *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can access any credential attached to their provider and with a DISPLAY_DELEGATION perimeter.
      operationId: SearchApiCredentials
      tags:
        - API Credentials
      parameters:
        - $ref: '#/components/parameters/CredentialIdFilter'
        - $ref: '#/components/parameters/CredentialProviderIdFilter'
        - $ref: '#/components/parameters/CredentialNameFilter'
        - $ref: '#/components/parameters/CredentialExpiresOnFilter'
        - $ref: '#/components/parameters/CredentialCreatedAtFilter'
        - $ref: '#/components/parameters/CredentialUpdatedAtFilter'
        - $ref: '#/components/parameters/CredentialLastUsedAtFilter'
        - $ref: '#/components/parameters/CredentialClientIdFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
             - `id`
             - `provider_id` (only for *MAN_ADMINISTRATOR* and *APNF* users)
             - `name`
             - `expires_on`
             - `created_at`
             - `updated_at`
             - `last_used_at`
             - `client_id`

            - `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(id|provider_id|name|expires_on|client_id|expires_on|last_used_at|(cre|upd)ated_(at|by)):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: name:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  credentials:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApiCredentialSummaryView'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /credentials/{credential_id}:
    get:
      summary: Return API credential details
      description: |
        Return a JSON object with API credential details.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can access any API credential owned by their provider.
      operationId: GetApiCredential
      tags:
        - API Credentials
      parameters:
        - $ref: '#/components/parameters/CredentialId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a JSON object with API credential details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCredential'
              examples:
                credential:
                  $ref: '#/components/examples/ApiCredential'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update API credential properties
      description: |
        Update API credential properties. Only `name`, `description` and `expires_on` settings can be updated.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* users can update any API credential owned by their provider.
        - *MANAGER* users can only update API credentials with CALL_AUTHENTICATION perimeter and owned by their provider.
        - *DELEGATION_MANAGER* users can only update API credentials with DISPLAY_DELEGATION perimeter and owned by their provider.
      operationId: UpdateApiCredential
      tags:
        - API Credentials
      parameters:
        - $ref: '#/components/parameters/CredentialId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 64
                  description: |
                    Change the name of the API credential.
                    - Cannot be deleted.
                  example: 'API Credential SI #2'
                description:
                  type: string
                  maxLength: 1024
                  description: |
                    Change the description of the API credential.
                    - Can be deleted.
                  example: Updated description of the credential.
                expires_on:
                  type: string
                  description: |
                    Change the expiration date of the API credential. Date shall be in ISO-8601 format.
                    - Can be deleted.
                  format: date-time
                  example: '2022-01-24T10:12:25Z'
            examples:
              ApiCredentialUpdateRequest:
                $ref: '#/components/examples/ApiCredentialUpdateRequest'
      responses:
        '200':
          description: Confirms successful processing and return the API credential properties in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCredential'
              examples:
                ApiCredential:
                  $ref: '#/components/examples/ApiCredential'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    delete:
      summary: Delete an API credential
      description: |
        Delete an API credential.
        Any follow-up authorization API call to request an access token using this credential will be rejected.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *DELEGATION_MANAGER*

        - *ADMINISTRATOR* users can delete any credential owned by their provider.
        - *MANAGER* users can only delete API credentials with CALL_AUTHENTICATION perimeter and owned by their provider.
        - *DELEGATION_MANAGER* users can only delete API credentials with DISPLAY_DELEGATION perimeter and owned by their provider.

        *Warning*: the action cannot be undone.
      operationId: DeleteApiCredential
      tags:
        - API Credentials
      parameters:
        - $ref: '#/components/parameters/CredentialId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /credentials/{credential_id}/history:
    get:
      summary: Retrieve activity history on API credentials
      description: |
        Retrieve a paginated list of all actions performed on an API credential.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER*, *DELEGATION_SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*, *DELEGATION_MANAGER* and *DELEGATION_SUPERVISOR* users can access the history of any credential owned by their provider.
      operationId: GetApiCredentialHistory
      tags:
        - API Credentials
        - History
      parameters:
        - $ref: '#/components/parameters/CredentialId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates:
    post:
      summary: Initiate the creation of a STI certificate
      description: |
        Initiate the creation of a new certificate. Shall always be called by the origin signing service provider.
        Two types of certificates can be created, for which the creation process will be different:
        * Direct certificates (type = `DIRECT`) are used directly by the origin signing service provider
        * Indirect certificates (type = `INDIRECT`) are requested by the origin signing service provider for a technical signing service provider (OPTS).

        While the creation of direct certificates is fully handled by this API, the process for indirect certificates is composed of 2 stages:
        * This API initiates the certificate request
        * The OPTS shall then call the `POST /certificates/{certificate_id}` to finalize the creation of the
          certificate.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* can initiate the creation of a new certificate only for its own provider.
      operationId: CreateCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: Certificate details
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - type
                - valid_from
              properties:
                name:
                  type: string
                  maxLength: 64
                  description: Certificate name provided by the origin service provider.
                  example: Main Certificate
                description:
                  type: string
                  maxLength: 1024
                  description: Additional information related to the certificate.
                  example: Description of the certificate.
                type:
                  $ref: '#/components/schemas/CertificateType'
                opts:
                  type: string
                  description: |
                    APNF code assigned to the technical service provider (OPTS).
                    Required if `type` is `INDIRECT`.
                    Otherwise shall not be specified.
                  pattern: ^([0-9A-Z]{6})$
                  example: SPB000
                csr:
                  type: string
                  maxLength: 2048
                  description: |
                    Contents of the CSR file used to create this certificate. Format of the contents is PEM.
                    Required if `type` is `DIRECT`.
                    Otherwise shall not be specified.
                  example: |
                    -----BEGIN CERTIFICATE REQUEST-----
                    MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
                    UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
                    ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
                    7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
                    MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
                    mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
                    -----END CERTIFICATE REQUEST-----
                test_certificate:
                  type: boolean
                  description: Is this a test certificate?
                  default: false
                  example: false
                valid_from:
                  type: string
                  description: |
                    Certificate validity start date. Date shall be in ISO-8601 format.

                    Unless `test_certificate` is set to `true`, the date shall be at least one week in the future.
                  format: date-time
                  example: '2022-01-17T10:12:25Z'
                valid_to:
                  type: string
                  description: |
                    Certificate expiration date. Date shall be in ISO-8601 format.

                    Required if `type` is `INDIRECT` or if `test_certificate` is set to `true`.
                  format: date-time
                  example: '2023-01-17T10:12:25Z'
                renewal_auto:
                  type: boolean
                  description: |
                    **Deprecated** Automated renewal option.

                    If provided, shall always be set to:
                    - `false` for test certificates
                    - `true` otherwise

                    This parameter will be removed in the future.
                  example: true
                renewal_after:
                  type: integer
                  description: |
                    Number of days to wait after certificate validity start date
                    for the automated certificate renewal process to be triggered.

                    Required if `test_certificate` is not set to `true`.
                    Otherwise, shall not be specified.
                  example: 300
            examples:
              DirectCertificateRequest:
                $ref: '#/components/examples/DirectCertificateRequest'
              IndirectCertificateRequest:
                $ref: '#/components/examples/IndirectCertificateRequest'
      responses:
        '201':
          description: |
            Confirms the creation of the new certificate and returns its details in the response.
            This applies only to direct certificates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                DirectCertificate:
                  $ref: '#/components/examples/DirectCertificate'
          headers:
            Location:
              $ref: '#/components/headers/Location-Certificate'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '202':
          description: |
            Confirms the indirect certificate creation request.
            This applies only to indirect certificates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingIndirectCertificate'
              examples:
                PendingIndirectCertificate:
                  $ref: '#/components/examples/PendingIndirectCertificate'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the provider has already too many active certificates.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: Maximum number of active certificates has been reached.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any certificate attached to their provider.
      operationId: SearchCertificates
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateIdFilter'
        - $ref: '#/components/parameters/CertificateProviderIdFilter'
        - $ref: '#/components/parameters/CertificateTypeFilter'
        - $ref: '#/components/parameters/CertificateOptsFilter'
        - $ref: '#/components/parameters/CertificateNameFilter'
        - $ref: '#/components/parameters/CertificateValidFromFilter'
        - $ref: '#/components/parameters/CertificateValidToFilter'
        - $ref: '#/components/parameters/CertificateTestCertificateFilter'
        - $ref: '#/components/parameters/CertificateStatusFilter'
        - $ref: '#/components/parameters/CertificateRenewalAutoFilter'
        - $ref: '#/components/parameters/CertificateRenewalAfterFilter'
        - $ref: '#/components/parameters/CertificateSnFilter'
        - $ref: '#/components/parameters/CertificateCreatedAtFilter'
        - $ref: '#/components/parameters/CertificateUpdatedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedReasonFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
              - `id`
              - `provider_id` (only for *MAN_ADMINISTRATOR* and *APNF* users)
              - `opts`
              - `name`
              - `valid_from`
              - `valid_to`
              - `status`
              - `sn`
              - `created_at`
              - `updated_at`
              - `revoked_at`
              - `revoked_reason`
              - `provider_code`
            - `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(id|provider_id|type|opts|name|valid_(from|to)|test_certificate|url|status|renew(al_a(uto|fter)|ed_by)|sn|(cre|upd)ated_(at|by)|revoked_(at|by|reason)|provider_code):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: name:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  certificates:
                    type: array
                    items:
                      $ref: '#/components/schemas/CertificateSummaryView'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/{certificate_id}:
    get:
      summary: Return STI certificate details
      description: |
        Return a JSON object with STI certificate details and contents.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any certificate attached to their provider.
      operationId: GetCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with certificate properties and contents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                DirectCertificate:
                  $ref: '#/components/examples/DirectCertificate'
                PendingIndirectCertificate:
                  $ref: '#/components/examples/PendingIndirectCertificate'
                IndirectCertificate:
                  $ref: '#/components/examples/IndirectCertificate'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    post:
      summary: Finalize the creation of an indirect STI certificate
      description: |
        API called by the technical signing service provider (OPTS) to finalize the creation of indirect certificates.

        Can only be called by the OPTS for which the indirect certificate has been requested for.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR*, *MANAGER* users can finalize any indirect certificate created for their provider.
      operationId: FinalizeIndirectCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: JSON object with certificate finalization options
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - csr
              properties:
                description:
                  type: string
                  maxLength: 1024
                  description: OPTS additional information for this certificate. Only available to the OPTS.
                  example: Description of the certificate.
                csr:
                  type: string
                  maxLength: 2048
                  description: |
                    Contents of the CSR file used to create this certificate. Format of the contents is PEM.
                  example: |
                    -----BEGIN CERTIFICATE REQUEST-----
                    MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
                    UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
                    ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
                    7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
                    MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
                    mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
                    -----END CERTIFICATE REQUEST-----
      responses:
        '201':
          description: |
            Confirms the finalization of the indirect certificate and returns its properties and contents in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                IndirectCertificate:
                  $ref: '#/components/examples/IndirectCertificate'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Returned when the API request cannot be fulfilled due to the object current status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPayloadError'
              example:
                code: CONFLICT
                message: Cannot finalize an expired certificate.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    patch:
      summary: Update STI certificate properties
      description: |
        Update certificate properties. Once the certificate has been created (for direct certificates)
        or finalized (for indirect certificates), only a subset of the certificate properties can be updated.

        - Indirect certificates that have not yet been finalised can have additional properties updated.
        - Expired certificates cannot be edited

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR*, *MANAGER* users can update any certificate created by/for their provider.
      operationId: UpdateCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        description: |
          A [JSON Merge Patch (RFC 7386)](https://datatracker.ietf.org/doc/html/rfc7386) containing only the properties
          that must be updated (with the new value) or deleted (with null as value).
        content:
          application/merge-patch+json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 64
                  description: |
                    Change the name of the certificate.
                    - Can be changed for both direct and indirect certificates
                    - Can be changed only by the origin service provider
                    - Cannot be deleted.
                  example: Main Certificate
                description:
                  type: string
                  maxLength: 1024
                  description: |
                    Change the description of the certificate.
                    - Can be changed for both direct and indirect certificates
                    - Can be changed by the origin service provider and the OPTS, each of them having their own description.
                    - Can be deleted.
                  example: Description of the certificate
                test_certificate:
                  type: boolean
                  description: |
                    Change the test certificate flag.
                    - Can be changed only for indirect certificates, if not finalized
                    - Can be changed only by the origin service provider
                    - Cannot be deleted.
                  example: false
                valid_from:
                  type: string
                  description: |
                    Change the certificate validity start date. Date shall be in ISO-8601 format.
                    - Can be changed only for indirect certificates not yet finalized
                    - Can be changed only by the origin service provider
                    - Unless `test_certificate` is set to `true`, the date shall be at least one week in the future.
                    - Cannot be deleted.
                  format: date-time
                  example: '2022-01-17T10:12:25Z'
                valid_to:
                  type: string
                  description: |
                    Change the certificate expiration date. Date shall be in ISO-8601 format.
                    - Can be changed only for indirect certificates not yet finalized
                    - Can be changed only by the origin service provider
                    - Cannot be deleted.
                  format: date-time
                  example: '2023-01-17T10:12:25Z'
                renewal_after:
                  type: integer
                  description: |
                    Change the number of days to wait after certificate validity start date to trigger the automatic renewal process.
                    - Cannot be specified for test certificates
                    - Can be changed otherwise

                    Can be changed only by the origin service provider
                  example: 300
            examples:
              DirectCertificateUpdateRequest:
                $ref: '#/components/examples/DirectCertificateUpdateRequest'
              PendingIndirectCertificateUpdateRequest:
                $ref: '#/components/examples/PendingIndirectCertificateUpdateRequest'
              IndirectCertificateUpdateRequest:
                $ref: '#/components/examples/IndirectCertificateUpdateRequest'
      responses:
        '200':
          description: Confirms successful processing and returns certificate properties and contents in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                DirectCertificate:
                  $ref: '#/components/examples/DirectCertificate'
                PendingIndirectCertificate:
                  $ref: '#/components/examples/PendingIndirectCertificate'
                IndirectCertificate:
                  $ref: '#/components/examples/IndirectCertificate'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    delete:
      summary: Delete a STI certificate
      description: |
        Delete a STI certificate. Only test certificates or certificates in *PENDING* status can be deleted.

        If a test certificate that is still valid is deleted, the platform will also revoke it and add it to the
        STI certificates CRL in the BPCO to ensure that it cannot be used for any further calls.

        *Warning*: the action cannot be undone.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* users can request deletion of any certificate attached to their own provider.

        *Note*: OPTS users cannot delete indirect certificates created for their provider.
      operationId: DeleteCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the certificate is already active and is not a test certificate.
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore.
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: This certificate is already active and it is not a test certificate.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/{certificate_id}/renew:
    post:
      summary: Renew a STI certificate
      description: |
        This method creates a new certificate using the same CSR and properties used for the
        creation of the certificate specified in the `certificate_id` request parameter.

        - Unless a `name` is provided, the Common Name of the new certificate will be the same, but the serial number will be different.
        - The `renewed_by` property of the current certificate will be filled with the id of the new certificate.
        - OPTS users cannot renew indirect certificates they have been mandated for.
        - Revoked certificates cannot be renewed
        - Invalid certificates cannot be renewed

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* can request renewal of certificates owned by their provider.
      operationId: RenewCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        description: |
          New properties may be specified for the creation of the new certificate.
          If not provided, values of the previous certificate will be kept, expect for the following:
          - `serial_number`: a new serial number is computed
          - `valid_from`: the date will be set to the current date & time + one week.
          - `valid_to`: the date will be computed so that the expiration delay will be the same than the one set for the initial certificate
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 64
                  description: |
                    Certificate name. Overrides the property set in the initial certificate used for the renewal.
                  example: Main Certificate
                description:
                  type: string
                  maxLength: 1024
                  description: |
                    Additional information related to the certificate.

                    If not specified, the description set to the initial certificate is reused.
                  example: Description of the certificate.
                valid_from:
                  type: string
                  description: |
                    Certificate validity start date. Date shall be in ISO-8601 format.

                    If not specified, the date will be set to the current date & time + one week.
                    The same rules used when creating a certificate also apply for renewal.
                  format: date-time
                  example: '2022-01-17T10:12:25Z'
                valid_to:
                  type: string
                  description: |
                    Certificate expiration date. Date shall be in ISO-8601 format.

                    If not specified, the date will be computed so that the expiration delay will
                    be the same than the one set for the initial certificate. The same rules used
                    when creating a certificate also apply for renewal.

                    This property cannot be specified for a direct certificate that is not flagged
                    as a test certificate, as the expiration is fixed to one year for such certificates.
                  format: date-time
                  example: '2023-01-17T10:12:25Z'
                renewal_auto:
                  type: boolean
                  description: |
                    **Deprecated** Automated renewal option.

                    If provided, shall always be set to:
                    - `false` for test certificates
                    - `true` otherwise

                    This parameter will be removed in the future.
                  example: true
                renewal_after:
                  type: integer
                  description: |
                    Number of days after certificate validity start date to wait for
                    the automated certificate renewal process to be triggered.

                    Can be specified if `test_certificate` is not set to `true`.
                    Otherwise, shall not be specified.

                    If not specified for a non-test certificate, the value will be copied from the initial certificate.
                  example: 350
      responses:
        '201':
          description: |
            Confirms the creation of the new certificate and returns its details and contents in the response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenewedCertificate'
              examples:
                DirectCertificate:
                  $ref: '#/components/examples/DirectCertificate'
          headers:
            Location:
              $ref: '#/components/headers/Location-Certificate'
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the certificate is revoked
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: This certificate is revoked.
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/{certificate_id}/revoke:
    post:
      summary: Revoke a STI certificate
      description: |
        Request the revocation of a certificate.
        Upon successful processing, the certificate will be immediately revoked by the platform.

        - OPTS users can revoke indirect certificates they have been mandated for.
        - Expired certificates cannot be revoked
        - Invalid certificates cannot be revoked
        - Revoked certificates cannot be revoked again

        *Warning*: the action cannot be undone.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*

        - *ADMINISTRATOR* and *MANAGER* users can request revocation of certificates attached to their own provider.
      operationId: RevokeCertificate
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - reason
              properties:
                reason:
                  type: string
                  nullable: false
                  description: |
                    Reason associated with the certificate revocation as defined in RFC 5280.
                  enum:
                    - unspecified
                    - keyCompromise
                    - affiliationChanged
                    - superseded
                    - cessationOfOperation
                    - certificateHold
                    - privilegeWithdrawn
                  default: unspecified
                  example: keyCompromise
                comments:
                  type: string
                  maxLength: 64
                  description: |
                    Additional comments on the reason for revoking the certificate.
                  example: Clé privée compromise
      responses:
        '204':
          $ref: '#/components/responses/SuccessNoMessage'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '409':
          description: Error returned when the certificate status is `EXPIRED`, `REVOKED`, `INVALIDATION` or `INVALID`
          content:
            application/json:
              schema:
                type: object
                required:
                  - code
                properties:
                  code:
                    type: string
                    description: Error code. Shall be capitalized with underscore
                    example: CONFLICT
                  message:
                    type: string
                    description: Message providing more details and context for error that occurred
                    example: This certificate is expired or is already revoked.
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/{certificate_id}/history:
    get:
      summary: Retrieve activity history on certificates
      description: |
        Retrieve a paginated list of all actions performed on a certificate.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access the history of any certificate attached to their provider.
      operationId: GetCertificateHistory
      tags:
        - History
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/export:
    get:
      summary: Retrieve a list of certificates in csv format with headers
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a list of
        corresponding results in csv format.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any certificate attached to their provider.
      operationId: ExportCertificates
      tags:
        - STI Certificates
      parameters:
        - $ref: '#/components/parameters/CertificateIdFilter'
        - $ref: '#/components/parameters/CertificateProviderIdFilter'
        - $ref: '#/components/parameters/CertificateTypeFilter'
        - $ref: '#/components/parameters/CertificateOptsFilter'
        - $ref: '#/components/parameters/CertificateNameFilter'
        - $ref: '#/components/parameters/CertificateValidFromFilter'
        - $ref: '#/components/parameters/CertificateValidToFilter'
        - $ref: '#/components/parameters/CertificateTestCertificateFilter'
        - $ref: '#/components/parameters/CertificateStatusFilter'
        - $ref: '#/components/parameters/CertificateRenewalAutoFilter'
        - $ref: '#/components/parameters/CertificateRenewalAfterFilter'
        - $ref: '#/components/parameters/CertificateSnFilter'
        - $ref: '#/components/parameters/CertificateCreatedAtFilter'
        - $ref: '#/components/parameters/CertificateUpdatedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedReasonFilter'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
              - `id`
              - `provider_id` (only for *MAN_ADMINISTRATOR* and *APNF* users)
              - `type`
              - `opts`
              - `name`
              - `valid_from`
              - `valid_to`
              - `test_certificate`
              - `url`
              - `status`
              - `renewal_auto`
              - `renewal_after`
              - `renewed_by`
              - `sn`
              - `created_at`
              - `created_by`
              - `updated_at`
              - `updated_by`
              - `revoked_at`
              - `revoked_by`
              - `revoked_reason`
            - `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(id|provider_id|type|opts|name|valid_(from|to)|test_certificate|url|status|renew(al_a(uto|fter)|ed_by)|sn|(cre|upd)ated_(at|by)|revoked_(at|by|reason)):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: name:asc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return certificates list in csv format with headers
          content:
            text/csv:
              schema:
                type: string
              example: |
                ID;status;name;serial_number;type;provider_code;opts;valid_from;valid_to;renewal_auto;days_before_renewal;bpco_url;description;test_certificate
                12;ACTIVE;Main Certificate;54e702c83df35b8a;DIRECT;SPC000;;2025-12-01T10:12:25Z;2026-01-01T10:12:25Z;true;9;https://api.man-bpco.fr/certs/SPC000/54e702c83df35b8a.cer;Description of the certificate.;false
                13;ACTIVE;Certificate;4df1d562e7f009e6;DIRECT;SPE000;;2025-12-01T10:12:25Z;2026-01-01T10:12:25Z;true;9;https://api.man-bpco.fr/certs/SPE000/4df1d562e7f009e6.cer;Description of the certificate.;false
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/archives:
    get:
      summary: Retrieve a paginated list of records with support of sorting & filtering
      description: |
        The API applies any sort and filter preferences passed to the API request and returns a paginated list of
        corresponding results.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any archived certificate attached to their provider.
      operationId: SearchArchivedCertificates
      tags:
        - STI Certificates (Archived)
      parameters:
        - $ref: '#/components/parameters/CertificateIdFilter'
        - $ref: '#/components/parameters/CertificateProviderIdFilter'
        - $ref: '#/components/parameters/CertificateTypeFilter'
        - $ref: '#/components/parameters/CertificateOptsFilter'
        - $ref: '#/components/parameters/CertificateNameFilter'
        - $ref: '#/components/parameters/CertificateValidFromFilter'
        - $ref: '#/components/parameters/CertificateValidToFilter'
        - $ref: '#/components/parameters/CertificateTestCertificateFilter'
        - $ref: '#/components/parameters/CertificateStatusFilter'
        - $ref: '#/components/parameters/CertificateRenewalAutoFilter'
        - $ref: '#/components/parameters/CertificateRenewalAfterFilter'
        - $ref: '#/components/parameters/CertificateSnFilter'
        - $ref: '#/components/parameters/CertificateCreatedAtFilter'
        - $ref: '#/components/parameters/CertificateUpdatedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedAtFilter'
        - $ref: '#/components/parameters/CertificateRevokedReasonFilter'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - name: sort
          in: query
          description: |
            Sort preference using the format `property_name:order`, where:
            - `property_name` is one of the following values:
              - `id`
              - `provider_id` (only for *MAN_ADMINISTRATOR* and *APNF* users)
              - `opts`
              - `name`
              - `valid_from`
              - `valid_to`
              - `status`
              - `archived`
              - `sn`
              - `created_at`
              - `updated_at`
              - `revoked_at`
            - `order` may be set to `asc` or `desc`.
          schema:
            type: string
            pattern: ^(id|provider_id|type|opts|name|valid_(from|to)|test_certificate|url|status|archived|renew(al_a(uto|fter)|ed_by)|sn|(cre|upd)ated_(at|by)|revoked_(at|by|reason)):(([Aa]|[Dd][Ee])[Ss][Cc])$
            example: created_at:desc
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of records
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  certificates:
                    type: array
                    items:
                      $ref: '#/components/schemas/ArchivedCertificateSummaryView'
        '400':
          $ref: '#/components/responses/ErrorCertificateValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/archives/{certificate_id}:
    get:
      summary: Return archived STI certificate details
      description: |
        Return a JSON object with STI archived certificate details and contents.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access any archived certificate attached to their provider.
      operationId: GetArchivedCertificate
      tags:
        - STI Certificates (Archived)
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return the JSON object with certificate properties and contents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Certificate'
              examples:
                DirectCertificate:
                  $ref: '#/components/examples/DirectArchivedCertificate'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '415':
          $ref: '#/components/responses/ErrorInvalidContentType'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /certificates/archives/{certificate_id}/history:
    get:
      summary: Retrieve activity history on STI archived certificates
      description: |
        Retrieve a paginated list of all actions performed on an STI archived certificate.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR*, *MANAGER* and *SUPERVISOR* users can access the history of any archived certificate attached to their provider.
      operationId: GetArchivedCertificateHistory
      tags:
        - History
        - STI Certificates (Archived)
      parameters:
        - $ref: '#/components/parameters/CertificateId'
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /history:
    get:
      summary: Retrieve platform activity history
      description: |
        Retrieve a paginated list of all actions performed on any data accessible to the user.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*

        - *ADMINISTRATOR* and *SUPERVISOR* can access the history of any data attached to their own provider.
        - *MANAGER* users can access the history on their own account or on certificates owned by their provider
      operationId: GetHistory
      tags:
        - History
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /bpco/certificates:
    head:
      summary: Get STI certificates last update date in BPCO
      description: |
        This method returns the date of the last update performed on STI certificates in the BPCO, i.e when a
        certificate has been published or removed.
        The date is returned in the `Last-Modified` response header.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*
      operationId: GetBpcoCertificatesLastUpdateDate
      tags:
        - BPCO
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          description: |
            Returns no contents. The `Last-Modified` header is set with the last update date of STI certificates in the BPCO.
          headers:
            Last-Modified:
              description: Last update date of certificates in the BPCO. Uses HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticatedNoContents'
        '403':
          $ref: '#/components/responses/ErrorNoPermissionNoContents'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeaderNoContents'
        '429':
          $ref: '#/components/responses/ErrorRateLimitingNoContents'
        '500':
          $ref: '#/components/responses/ErrorInternalNoContents'
        '503':
          $ref: '#/components/responses/ServiceUnavailableNoContents'
    get:
      summary: Get a copy of STI certificates in BPCO
      description: |
        This method returns as a GZipped TAR file a copy of all the STI certificates currently published in the BPCO.

        If the `since` parameter is specified, the GZipped TAR file only contains the certificates published in the BPCO or
        removed from it since the date provided in the parameter.
        The list of certificates removed from the BPCO are available in a `removed-certificates.csv` file included in the tarball.

        A `If-Modified-Since` request header may also be specified. In that case, a **304** response is returned if no certificates
        have been added or removed since the date specified in the header. This latter can be filled with the value of the
        `Last-Modified` response header collected from a previous call to this API or the `HEAD /bpco/certificates` one.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*
      operationId: GetBpcoCertificatesCopy
      tags:
        - BPCO
      parameters:
        - name: since
          in: query
          description: |
            Date in ISO-8601 format. When specified, return only the certificates added or removed since that date.
            The minutes and seconds are ignored (`2022-01-17T10:12:25Z` is therefore interpreted as `2022-01-17T10:00:00Z`)
            and the date cannot be older than 15 days.
          required: false
          schema:
            type: string
            format: date-time
            example: '2022-01-19T10:00:00Z'
        - $ref: '#/components/parameters/If-Modified-Since'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: |
            Return a GZipped TAR file which includes the certificates using the following structure:
            ```
            |-<Service Provider Code #A>/
            |  |- <serial number certificat #A1>.cer
            |  |- <serial number certificat #A2>.cer
            |  `- <serial number certificat #A3>.cer
            |-<Service Provider Code #B>/
            |  |- <serial number certificat #B1>.cer
            |  |- <serial number certificat #B2>.cer
            |-<Service Provider Code #C>/
            [...]
            ```
            If the `since` parameter is present, a `removed-certificates.csv` file may be included at the root of the
            GZipped TAR file.
            When present, this file lists all certificates deleted from the BPCO since that date, using the following
            format:
            ```ini
            <Service Provider Code #A>;<serial number certificat #A4>
            <Service Provider Code #B>;<serial number certificat #B3>
            <Service Provider Code #C>;<serial number certificat #C2>
            ```
            A semicolon (`;`, `U+003B`) is used between each column and a linefeed is used between each line
            (`\n`, `U+000A`).
          content:
            application/gzip:
              schema:
                type: string
                format: binary
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            Last-Modified:
              description: Last update date of STI certificates in the BPCO. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '304':
          description: No changes since the date provided in the `If-Modified-Since` request header.
          headers:
            Last-Modified:
              description: Last update date of STI certificates in the BPCO. Uses HTTP-Date format (RFC 7231)
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-GZip'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /bpco/certificates/history:
    get:
      summary: Retrieve activity history on the certificate public repository
      description: |
        Retrieve a paginated list of all actions performed on the list of STI certificates in the BPCO.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: GetBpcoCertificatesHistory
      tags:
        - BPCO
        - History
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /bpco/crl:
    head:
      summary: Get STI certificates CRL last update date in BPCO
      description: |
        This method returns the date of the last update performed on the Certificate Revocation List (CRL) of
        STI certificates in the BPCO, i.e when a STI certificate has been revoked or when certificate is remove from the CRL.
        The date is returned in the `Last-Modified` response header.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*
      operationId: GetBpcoCrlLastUpdateDate
      tags:
        - BPCO
      parameters:
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '204':
          description: |
            Returns no contents. The `Last-Modified` header is set with the last update date of STI certificates CRL in
            the BPCO.
          headers:
            Last-Modified:
              description: Last update date of STI certificates CRL in the BPCO. Uses HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticatedNoContents'
        '403':
          $ref: '#/components/responses/ErrorNoPermissionNoContents'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeaderNoContents'
        '429':
          $ref: '#/components/responses/ErrorRateLimitingNoContents'
        '500':
          $ref: '#/components/responses/ErrorInternalNoContents'
        '503':
          $ref: '#/components/responses/ServiceUnavailableNoContents'
    get:
      summary: Get a copy of the STI certificates CRL in BPCO
      description: |
        Get a copy of the STI certificates Certificate Revocation List (CRL) as available in the BPCO.

        The API returns the CRL in DER format, with the exact same contents returned by the BPCO API `GET /crl`.

        A `If-Modified-Since` request header may also be specified. In that case, a **304** response is returned
        if the CRL has not been updated since the date specified in the header. This latter can be filled with the value of the
        `Last-Modified` response header collected from a previous call to this API or the `HEAD /bpco/crl` one.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*
      operationId: GetBpcoCrlCopy
      tags:
        - BPCO
      parameters:
        - $ref: '#/components/parameters/If-Modified-Since'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: The Certificate Revocation List in DER format.
          content:
            application/pkix-crl:
              schema:
                type: string
                format: binary
                example: |

                  00000000: 3082 0120 3081 c802 0101 300a 0608 2a86  0.. 0.....0...*.
                  00000010: 48ce 3d04 0302 3067 3111 300f 0603 5504  H.=...0g1.0...U.
                  00000020: 030c 0842 5043 4f20 5041 3131 0b30 0906  ...BPCO PA11.0..
                  00000030: 0355 0406 1302 4652 312a 3028 0603 5504  .U....FR1*0(..U.
                  00000040: 0a0c 2142 6173 6520 6465 7320 4365 7274  ..!Base des Cert
                  00000050: 6966 6963 6174 7320 4f70 c383 c2a9 7261  ificats Op....ra
                  00000060: 7465 7572 3119 3017 0603 5504 0b0c 1050  teur1.0...U....P
                  00000070: 6f6c 6963 7920 4175 7468 6f72 6974 7917  olicy Authority.
                  00000080: 0d32 3230 3730 3431 3235 3032 305a 170d  .220704125020Z..
                  00000090: 3232 3038 3033 3132 3530 3230 5aa0 3030  220803125020Z.00
                  000000a0: 2e30 1f06 0355 1d23 0418 3016 8014 097a  .0...U.#..0....z
                  000000b0: 34d8 9663 a43e 0250 9294 9de2 de31 8135  4..c.>.P.....1.5
                  000000c0: 3c8a 300b 0603 551d 1404 0402 0210 0030  <.0...U........0
                  000000d0: 0a06 082a 8648 ce3d 0403 0203 4700 3044  ...*.H.=....G.0D
                  000000e0: 0220 58da 50e6 2670 a7e4 413d bb9d c193  . X.P.&p..A=....
                  000000f0: e0c0 3852 0138 1bd0 73fc 04fa 7328 952b  ..8R.8..s...s(.+
                  00000100: e169 0220 1110 3e86 450b f0db 4345 80c9  .i. ..>.E...CE..
                  00000110: b12e d905 9f72 051a e02d fd3d 67d7 4ce2  .....r...-.=g.L.
                  00000120: b92f e546                                ./.F
          headers:
            Last-Modified:
              description: Last update date of STI certificates CRL in the BPCO. Uses HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Length:
              description: Size in bytes of the DER contents provided in the response.
              schema:
                type: integer
                example: 311
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '304':
          description: No changes since the date provided in the `If-Modified-Since` request header
          headers:
            Last-Modified:
              description: Last update date of STI certificates CRL in the BPCO. Uses HTTP-Date format (RFC 7231).
              schema:
                $ref: '#/components/schemas/RFC7231.HTTP-date'
            Content-Type:
              $ref: '#/components/headers/Content-Type-Pkix-Crl'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '405':
          $ref: '#/components/responses/ErrorNotAllowed'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /bpco/crl/history:
    get:
      summary: Retrieve activity history on the CRL
      description: |
        Retrieve a paginated list of all actions performed on the STI certificates CRL in the BPCO.
        Sorting and filtering are not supported for this API.

        **Allowed Roles**: *ADMINISTRATOR*, *MANAGER*, *SUPERVISOR*
      operationId: GetBpcoCrlHistory
      tags:
        - BPCO
        - History
      parameters:
        - $ref: '#/components/parameters/PaginationLimit'
        - $ref: '#/components/parameters/PaginationOffset'
        - $ref: '#/components/parameters/X-Request-Id'
      responses:
        '200':
          description: Return a paginated list of history records
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    $ref: '#/components/schemas/PaginationMetaData'
                  records:
                    type: array
                    items:
                      $ref: '#/components/schemas/History'
          headers:
            Content-Length:
              $ref: '#/components/headers/Content-Length'
            X-Correlation-Id:
              $ref: '#/components/headers/X-Correlation-Id'
            X-Response-Id:
              $ref: '#/components/headers/X-Response-Id'
        '400':
          $ref: '#/components/responses/ErrorValidation'
        '401':
          $ref: '#/components/responses/ErrorNotAuthenticated'
        '403':
          $ref: '#/components/responses/ErrorNoPermission'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '406':
          $ref: '#/components/responses/ErrorInvalidAcceptHeader'
        '429':
          $ref: '#/components/responses/ErrorRateLimiting'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
security:
  - access_token: []
components:
  examples:
    ApiCredential:
      summary: Details of an API credential
      value:
        id: 9152f121-f66f-421c-87ce-78b218e250d4
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        name: 'API Credential SI #1'
        client_id: OPC000_001
        perimeter:
          - CALL_AUTHENTICATION
          - DISPLAY_DELEGATION
        description: Description of the credential.
        expires_on: '2022-01-24T10:12:25Z'
        last_used_at: '2022-01-20T10:12:25Z'
        created_at: '2022-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: John Doe <john.doe@spa.domain>
    ApiCredentialCreationResponse:
      summary: API credential creation response
      value:
        id: 9152f121-f66f-421c-87ce-78b218e250d4
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        name: 'API Credential SI #1'
        client_id: OPC000_001
        client_secret: 7AD6F8F12F5B091E6DAEB1979F76DFBB
        perimeter:
          - CALL_AUTHENTICATION
          - DISPLAY_DELEGATION
        description: Description of the credential.
        expires_on: '2022-01-24T10:12:25Z'
        created_at: '2022-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: John Doe <john.doe@spa.domain>
    ApiCredentialUpdateRequest:
      summary: Request to update all possible properties of an API credential
      value:
        name: API Credential (no expiration)
        description: This API credential shall not expire
        expires_on: null
    ApnfUserCreationResponse:
      summary: Response for APNF user creation
      value:
        id: 155720a6-f4c9-40ec-b479-a32d7f062553
        firstname: Mark
        lastname: Jones
        email_address: mark.jones@apnf
        mobile_phone: '+33612345678'
        language: FRENCH
        roles:
          - APNF
        status: PENDING
        created_at: '2022-01-17T10:12:25Z'
        created_by: MAN Administrator <support@man-platform>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: MAN Administrator <support@man-platform>
    BypassTokenCreationResponse:
      value:
        id: SPC000-YE42L73SGAG45I05
    DelegationTicket:
      value:
        id: 14fa2014-8b50-4159-a250-789ebf4500e6
        issue_type: INCIDENT
        delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
        typology_code: D1
        typology_label: Display delegation procedure blocked
        typology_criticality: 2
        description: This is not the first time
        provider_author_role: OPE
        next_action_required_by: OPE200
        tns:
          - '102030406'
          - 0100-0200
        estimated_issue_date: '2022-01-17T10:12:25Z'
        provider_author_apnf_code: OPE100
        modification_author_apnf_code: OPE100
        status: OPEN
        resolution: null
        creation_date: '2022-01-17T10:12:25Z'
        creation_author: 61757468-6f72-2d31-3030-000000000000
        modification_date: '2022-01-17T10:12:25Z'
        modification_author: 61757468-6f72-2d31-3030-000000000123
        reference_id: 1
        automatically_updated: false
        author_ticket_internal_id: My_Internal_ID123
        ope: OPE100
        osp: OPE200
    DelegationTicketClosed:
      value:
        id: 14fa2014-8b50-4159-a250-789ebf4500e6
        issue_type: INCIDENT
        delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
        typology_code: D1
        typology_label: Display delegation procedure blocked
        typology_criticality: 2
        description: This is not the first time
        provider_author_role: OPE
        next_action_required_by: OPE200
        tns:
          - '102030406'
          - 0100-0200
        estimated_issue_date: '2022-01-17T10:12:25Z'
        provider_author_apnf_code: OPE100
        modification_author_apnf_code: OPE100
        status: CLOSED
        resolution: FIXED
        creation_date: '2022-01-17T10:12:25Z'
        creation_author: 61757468-6f72-2d31-3030-000000000000
        modification_date: '2022-01-17T10:12:25Z'
        modification_author: 61757468-6f72-2d31-3030-000000000123
        reference_id: 1
        automatically_updated: false
        author_ticket_internal_id: My_Internal_ID123
        ope: OPE100
        osp: OPE200
    DelegationTicketPatch:
      value:
        tns:
          - '102030406'
          - 0100-0200
        delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
        description: This is not the first time
        next_action_required_by: OPE100
        estimated_issue_date: '2022-01-17T10:12:25Z'
        author_ticket_internal_id: My_Internal_ID123
    DirectArchivedCertificate:
      summary: Details of an archived direct certificate
      value:
        id: d240dd9e-a077-42f5-92e3-a3d3f10e002e
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        type: DIRECT
        name: Main Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2021-01-17T10:12:25Z'
        valid_to: '2023-01-17T10:12:25Z'
        renewal_auto: true
        renewal_after: 300
        status: REVOKED
        archived: true
        sn: 57ABB34BCA510043BDE438460F13B27E6A82C004
        url: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        contents: |
          -----BEGIN CERTIFICATE-----
          MIIC/DCCAqOgAwIBAgIUV6uzS8pRAEO95DhGDxOyfmqCwAQwCgYIKoZIzj0EAwIw
          gYcxLDAqBgNVBAMMI0JQQ08gQ0ExIMOiwoDCkyBTSEFLRU4gSW50ZXJtZWRpYXRl
          MQswCQYDVQQGEwJGUjEqMCgGA1UECgwhQmFzZSBkZXMgQ2VydGlmaWNhdHMgT3DD
          g8KpcmF0ZXVyMR4wHAYDVQQLDBVDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjIw
          NzA0MTAwMDMxWhcNMjIxMDAyMTAwMDMxWjBXMRYwFAYDVQQDDA1TSEFLRU4gT1BD
          MDAwMQswCQYDVQQGEwJGUjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQL
          DBBTZXJ2aWNlIFByb3ZpZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/
          qQeNfCytgqjIETfjmVEw7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0
          ULplSrl9+QrrpKLwjKOCARowggEWMB0GA1UdDgQWBBRk53mcS8XiTcavdh4VBd3j
          RA803zAfBgNVHSMEGDAWgBRNelLrS9FcVoyWR7d8FHJRlixuBDAOBgNVHQ8BAf8E
          BAMCB4AwDAYDVR0TAQH/BAIwADCBmwYDVR0fBIGTMIGQMIGNoB6gHIYaaHR0cHM6
          Ly88ZG9tYWluZS1icGNvPi9jcmyia6RpMGcxCzAJBgNVBAYTAkZSMSowKAYDVQQK
          DCFCYXNlIGRlcyBDZXJ0aWZpY2F0cyBPcMODwqlyYXRldXIxGTAXBgNVBAsMEFBv
          bGljeSBBdXRob3JpdHkxETAPBgNVBAMMCEJQQ08gUEExMBgGCCsGAQUFBwEaBAww
          CqAIFgZPUEMwMDAwCgYIKoZIzj0EAwIDRwAwRAIgNBAcIP/Gwx1rXvI2/PiflboV
          YVc3KWvfczSpXEMF61oCIG64G0cYxoO00MBdY+vg6umsNtA6eT0q5G6wW7dNjOTv
          -----END CERTIFICATE-----
        csr: |
          -----BEGIN CERTIFICATE REQUEST-----
          MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
          UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
          ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
          7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
          MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
          mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
          -----END CERTIFICATE REQUEST-----
        created_at: '2021-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: John Doe <john.doe@spa.domain>
        revoked_at: '2022-01-30T09:10:00Z'
        revoked_by: John Doe <john.doe@spa.domain>
        revoked_reason: keyCompromise
        revoked_comments: Clé privée compromise
        issuer_dn: CN=BPCO CA1 - SHAKEN Intermediate,O=Base des Certificats Opérateurs,OU=Certificate Authority,C=FR
    DirectCertificate:
      summary: Details of an active direct certificate
      value:
        id: d240dd9e-a077-42f5-92e3-a3d3f10e002e
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        type: DIRECT
        name: Main Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2022-01-17T10:12:25Z'
        valid_to: '2023-01-17T10:12:25Z'
        renewal_auto: true
        renewal_after: 300
        status: ACTIVE
        archived: false
        sn: 57ABB34BCA510043BDE438460F13B27E6A82C004
        url: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        contents: |
          -----BEGIN CERTIFICATE-----
          MIIC/DCCAqOgAwIBAgIUV6uzS8pRAEO95DhGDxOyfmqCwAQwCgYIKoZIzj0EAwIw
          gYcxLDAqBgNVBAMMI0JQQ08gQ0ExIMOiwoDCkyBTSEFLRU4gSW50ZXJtZWRpYXRl
          MQswCQYDVQQGEwJGUjEqMCgGA1UECgwhQmFzZSBkZXMgQ2VydGlmaWNhdHMgT3DD
          g8KpcmF0ZXVyMR4wHAYDVQQLDBVDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjIw
          NzA0MTAwMDMxWhcNMjIxMDAyMTAwMDMxWjBXMRYwFAYDVQQDDA1TSEFLRU4gT1BD
          MDAwMQswCQYDVQQGEwJGUjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQL
          DBBTZXJ2aWNlIFByb3ZpZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/
          qQeNfCytgqjIETfjmVEw7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0
          ULplSrl9+QrrpKLwjKOCARowggEWMB0GA1UdDgQWBBRk53mcS8XiTcavdh4VBd3j
          RA803zAfBgNVHSMEGDAWgBRNelLrS9FcVoyWR7d8FHJRlixuBDAOBgNVHQ8BAf8E
          BAMCB4AwDAYDVR0TAQH/BAIwADCBmwYDVR0fBIGTMIGQMIGNoB6gHIYaaHR0cHM6
          Ly88ZG9tYWluZS1icGNvPi9jcmyia6RpMGcxCzAJBgNVBAYTAkZSMSowKAYDVQQK
          DCFCYXNlIGRlcyBDZXJ0aWZpY2F0cyBPcMODwqlyYXRldXIxGTAXBgNVBAsMEFBv
          bGljeSBBdXRob3JpdHkxETAPBgNVBAMMCEJQQ08gUEExMBgGCCsGAQUFBwEaBAww
          CqAIFgZPUEMwMDAwCgYIKoZIzj0EAwIDRwAwRAIgNBAcIP/Gwx1rXvI2/PiflboV
          YVc3KWvfczSpXEMF61oCIG64G0cYxoO00MBdY+vg6umsNtA6eT0q5G6wW7dNjOTv
          -----END CERTIFICATE-----
        csr: |
          -----BEGIN CERTIFICATE REQUEST-----
          MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
          UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
          ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
          7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
          MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
          mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
          -----END CERTIFICATE REQUEST-----
        created_at: '2022-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: John Doe <john.doe@spa.domain>
        issuer_dn: CN=BPCO CA1 - SHAKEN Intermediate,O=Base des Certificats Opérateurs,OU=Certificate Authority,C=FR
    DirectCertificateRequest:
      summary: Request for a direct certificate
      value:
        type: DIRECT
        name: Main Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2022-01-17T10:12:25Z'
        renewal_auto: true
        renewal_after: 300
        csr: |
          -----BEGIN CERTIFICATE REQUEST-----
          MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
          UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
          ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
          7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
          MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
          mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
          -----END CERTIFICATE REQUEST-----
    DirectCertificateUpdateRequest:
      summary: Request to update all possible properties of a direct certificate
      value:
        name: Certificate new name.
        description: Updated description of the certificate.
        renewal_auto: false
    DisplayDelegationSummaryListForAPNF:
      summary: Paginated list of records for APNF
      value:
        metadata:
          offset: 40,
          limit: 20,
          links:
            next: /resource?offset=60&limit=20
            first: /resource?offset=0&limit=20
            prev: /resource?offset=20&limit=20
        delegations:
          id: 7f141d29-17a0-45cd-8df3-92c41649263b
          tn_start: 33123456789
          tn_end: 33123456900
          delegation_request_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
          status: ACTIVE
          expiration_date: '2022-01-17T10:12:25Z'
          ope: OPC000
          osp: OPC001
          delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
          created_at: '2020-01-17T10:12:25Z'
    DisplayDelegationSummaryListForOPE:
      summary: Paginated list of records for OPE
      value:
        metadata:
          offset: 40,
          limit: 20,
          links:
            next: /resource?offset=60&limit=20
            first: /resource?offset=0&limit=20
            prev: /resource?offset=20&limit=20
        delegations:
          tn_start: 33123456789
          tn_end: 33123456900
          status: ACTIVE
          expiration_date: '2022-01-17T10:12:25Z'
          role: OPE
          delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
          ope_information: Lorem ipsum...
          created_at: '2020-01-17T10:12:25Z'
          created_by: API
          updated_at: '2020-01-17T10:12:25Z'
          updated_by: API
          delegation_request_id: 30f069c5-072a-4488-9170-ef898e16d1a5
    DisplayDelegationSummaryListForOSP:
      summary: Paginated list of records for OSP
      value:
        metadata:
          offset: 40,
          limit: 20,
          links:
            next: /resource?offset=60&limit=20
            first: /resource?offset=0&limit=20
            prev: /resource?offset=20&limit=20
        delegations:
          id: 7f141d29-17a0-45cd-8df3-92c41649263b
          tn_start: 33123456789
          tn_end: 33123456900
          status: ACTIVE
          expiration_date: '2022-01-17T10:12:25Z'
          role: OSP
          delegatee_id: 9d82a078-01cb-4a70-a529-14b7e57d4a21
          osp_client_internal_id: CLIENT-SI054
          created_at: '2020-01-17T10:12:25Z'
          delegation_request_id: 30f069c5-072a-4488-9170-ef898e16d1a5
    IndirectCertificate:
      summary: Details of an indirect certificate finalized by the OPTS
      value:
        id: d240dd9e-a077-42f5-92e3-a3d3f10e002e
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        type: INDIRECT
        opts: SPB000
        name: Indirect Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2022-03-01T00:00:00Z'
        valid_to: 2022-05-3123:59:59Z
        renewal_auto: false
        status: ACTIVE
        archived: false
        sn: 57ABB34BCA510043BDE438460F13B27E6A82C004
        url: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        contents: |
          -----BEGIN CERTIFICATE-----
          MIIC/DCCAqOgAwIBAgIUV6uzS8pRAEO95DhGDxOyfmqCwAQwCgYIKoZIzj0EAwIw
          gYcxLDAqBgNVBAMMI0JQQ08gQ0ExIMOiwoDCkyBTSEFLRU4gSW50ZXJtZWRpYXRl
          MQswCQYDVQQGEwJGUjEqMCgGA1UECgwhQmFzZSBkZXMgQ2VydGlmaWNhdHMgT3DD
          g8KpcmF0ZXVyMR4wHAYDVQQLDBVDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjIw
          NzA0MTAwMDMxWhcNMjIxMDAyMTAwMDMxWjBXMRYwFAYDVQQDDA1TSEFLRU4gT1BD
          MDAwMQswCQYDVQQGEwJGUjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQL
          DBBTZXJ2aWNlIFByb3ZpZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/
          qQeNfCytgqjIETfjmVEw7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0
          ULplSrl9+QrrpKLwjKOCARowggEWMB0GA1UdDgQWBBRk53mcS8XiTcavdh4VBd3j
          RA803zAfBgNVHSMEGDAWgBRNelLrS9FcVoyWR7d8FHJRlixuBDAOBgNVHQ8BAf8E
          BAMCB4AwDAYDVR0TAQH/BAIwADCBmwYDVR0fBIGTMIGQMIGNoB6gHIYaaHR0cHM6
          Ly88ZG9tYWluZS1icGNvPi9jcmyia6RpMGcxCzAJBgNVBAYTAkZSMSowKAYDVQQK
          DCFCYXNlIGRlcyBDZXJ0aWZpY2F0cyBPcMODwqlyYXRldXIxGTAXBgNVBAsMEFBv
          bGljeSBBdXRob3JpdHkxETAPBgNVBAMMCEJQQ08gUEExMBgGCCsGAQUFBwEaBAww
          CqAIFgZPUEMwMDAwCgYIKoZIzj0EAwIDRwAwRAIgNBAcIP/Gwx1rXvI2/PiflboV
          YVc3KWvfczSpXEMF61oCIG64G0cYxoO00MBdY+vg6umsNtA6eT0q5G6wW7dNjOTv
          -----END CERTIFICATE-----
        csr: |
          -----BEGIN CERTIFICATE REQUEST-----
          MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
          UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
          ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
          7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
          MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
          mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
          -----END CERTIFICATE REQUEST-----
        created_at: '2022-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: Jane Doe <jane.doe@spb>
        issuer_dn: CN=BPCO CA1 - SHAKEN Intermediate,O=Base des Certificats Opérateurs,OU=Certificate Authority,C=FR
    IndirectCertificateRequest:
      summary: Request for an indirect certificate
      value:
        type: INDIRECT
        opts: SPB000
        name: Indirect Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2022-03-01T00:00:00Z'
        valid_to: 2022-05-3123:59:59Z
        renewal_after: 90
    IndirectCertificateUpdateRequest:
      summary: Request to update all possible properties of a finalized indirect certificate
      value:
        name: Certificate new name.
        description: Updated description of the certificate.
        renewal_after: 300
    Meteo:
      value:
        ID: 14fa2014-8b50-4159-a250-789ebf4500e6
        provider_author_apnf_code: OPE100
        short_description: L'opérateur OPE1 est en débrayage
        long_description: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... '
        criticality: INFORMATION
        start_date: '2022-01-17T10:12:25Z'
        end_date: '2022-01-18T10:12:25Z'
        tags:
          - APPLICATION_MAN
        reference_id: 1
    MeteoCreation:
      value:
        ID: 14fa2014-8b50-4159-a250-789ebf4500e6
        provider_author_apnf_code: OPE100
        short_description: L'opérateur OPE1 est en débrayage
        long_description: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... '
        criticality: INFORMATION
        start_date: '2022-01-17T10:12:25Z'
    MeteoDisengagement:
      value:
        ID: 14fa2014-8b50-4159-a250-789ebf4500e8
        provider_author_apnf_code: OPE100
        short_description: L'opérateur OPE1 est en débrayage
        long_description: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... '
        criticality: INFORMATION
        start_date: '2022-01-17T10:12:25Z'
        end_date: '2022-01-18T10:12:25Z'
        tags:
          - DISENGAGEMENT
        disengagement_id: APNF00-123456789-ABCDE
        reference_id: 1
    MeteoPatch:
      value:
        short_description: L'opérateur OPE1 est en débrayage
        long_description: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... et il est intervenu pour... '
        criticality: INFORMATION
        start_date: '2022-01-17T10:12:25Z'
        end_date: '2022-01-18T10:12:25Z'
    OtpResetRequestUsingEmailAddress:
      summary: OTP Reset Request using an email address
      value:
        email_address: john.doe@spa.domain
        otp: true
    PasswordResetRequestUsingEmailAddress:
      summary: Password Reset Request using an email address
      value:
        email_address: john.doe@spa.domain
    PasswordResetRequestUsingUserId:
      summary: Request using a user ID (MAN_ADMINISTRATOR / ADMINISTRATOR only)
      value:
        user_id: 155720a6-f4c9-40ec-b479-a32d7f062553
    PendingIndirectCertificate:
      summary: Details of an indirect certificate not yet finalized
      value:
        id: d240dd9e-a077-42f5-92e3-a3d3f10e002e
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        type: INDIRECT
        opts: SPB000
        name: Indirect Certificate
        description: Description of the certificate.
        test_certificate: false
        valid_from: '2022-03-01T00:00:00Z'
        valid_to: 2022-05-3123:59:59Z
        renewal_auto: false
        status: PENDING
        archived: false
        created_at: '2022-01-17T10:12:25Z'
        created_by: John Doe <john.doe@spa.domain>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: John Doe <john.doe@spa.domain>
    PendingIndirectCertificateUpdateRequest:
      summary: Request to update all possible properties of a pending indirect certificate
      value:
        name: Certificate new name.
        description: Updated description of the certificate.
        test_certificate: false
        valid_from: '2022-06-01T00:00:00Z'
        valid_to: '2023-01-00T00:00:00Z'
        renewal_after: 300
    ProviderDetails:
      value:
        id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        status: REGISTRATION
        name: Opérateur A
        code: SPA000
        address: 30, rue de Paris 75018 Paris
        technical_number: '+33123456789'
        signatory: true
        opts: true
        legal_administrator: John Doe <john.doe@spa.domain>
        opts_contracts:
          - SPB000
          - SPC000
          - SPD000
        opts_allowed:
          - SPE000
          - SPF000
          - SPG000
        global_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        certificate_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        legal_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticketing_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticket_notification_active: true
        delegation_near_expiration_notification_active: true
        delegation_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        delegation_ticket_notification_active: true
        delegation_ticketing_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        sftp_allowed_ips:
          - 172.16.25.6
        languages:
          - FRENCH
          - ENGLISH
        authentication_mode: MFA
        last_verification:
          id: 9152f121-f66f-421c-87ce-78b218e250d4
          status: COMPLETED
          decision: true
          completed_at: '2022-05-18T10:12:25Z'
        deleted: false
        created_at: '2022-01-17T10:12:25Z'
        created_by: MAN Administrator <support@man-platform>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: MAN Administrator <support@man-platform>
        bypass_token: SPC000-YE42L73SGAG45I05
        default_notification_language: FRENCH
        global_notification_list_language: FRENCH
        certificate_notification_list_language: DEFAULT
        deposit_notification_list_language: DEFAULT
        legal_notification_list_language: DEFAULT
        ticketing_notification_list_language: DEFAULT
        delegation_notification_list_language: ENGLISH
        delegation_ticketing_notification_list_language: ENGLISH
    ProviderUpdateRequestByAdministrator:
      summary: Request to update all possible provider properties with an administrator user
      value:
        address: 30, rue de Paris 75018 Paris
        technical_number: '+33123456789'
        global_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        certificate_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        legal_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticketing_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticket_notification_active: true
        sftp_allowed_ips:
          - 172.16.25.6
        languages:
          - FRENCH
          - ENGLISH
        authentication_mode: MFA
        default_notification_language: FRENCH
        global_notification_list_language: FRENCH
        certificate_notification_list_language: DEFAULT
        deposit_notification_list_language: DEFAULT
        legal_notification_list_language: DEFAULT
        ticketing_notification_list_language: DEFAULT
        delegation_notification_list_language: ENGLISH
        delegation_ticketing_notification_list_language: ENGLISH
    ProviderUpdateRequestByManAdministrator:
      summary: Request to update all possible provider properties with a MAN administrator user
      value:
        status: DISABLED
        name: Opérateur A
        address: 30, rue de Paris 75018 Paris
        technical_number: '+33123456789'
        signatory: true
        opts: true
        legal_administrator: 155720a6-f4c9-40ec-b479-a32d7f062553
        opts_contracts:
          - SPB000
          - SPC000
          - SPD000
        global_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        certificate_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        legal_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticketing_notification_list:
          - john.doe@spa.domain
          - jane.doe@spa.domain
        ticket_notification_active: true
        sftp_allowed_ips:
          - 172.16.25.6
        languages:
          - FRENCH
          - ENGLISH
        authentication_mode: MFA
        default_notification_language: FRENCH
        global_notification_list_language: FRENCH
        certificate_notification_list_language: DEFAULT
        deposit_notification_list_language: DEFAULT
        legal_notification_list_language: DEFAULT
        ticketing_notification_list_language: DEFAULT
        delegation_notification_list_language: ENGLISH
        delegation_ticketing_notification_list_language: ENGLISH
    ProviderUser:
      summary: Details of a provider user
      value:
        id: 155720a6-f4c9-40ec-b479-a32d7f062553
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        mobile_phone: '+33612345678'
        language: ENGLISH
        roles:
          - ADMINISTRATOR
        status: PENDING
        created_at: '2022-01-17T10:12:25Z'
        created_by: MAN Administrator <support@man-platform>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: MAN Administrator <support@man-platform>
        last_connected_at: '2022-03-07T08:30:12Z'
        legal_administrator: true
    ProviderUserCreationRequestByAdministrator:
      summary: Creation of a provider MANAGER user by provider administrator
      value:
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        roles:
          - MANAGER
        mobile_phone: '+33612345678'
    ProviderUserCreationRequestByManAdministrator:
      summary: Creation of a provider ADMINISTRATOR user by platform administrator
      value:
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        mobile_phone: '+33612345678'
        language: ENGLISH
        roles:
          - ADMINISTRATOR
    ProviderUserCreationResponse:
      summary: Response for provider ADMINISTRATOR user creation
      value:
        id: 155720a6-f4c9-40ec-b479-a32d7f062553
        provider_id: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        mobile_phone: '+33612345678'
        language: ENGLISH
        roles:
          - ADMINISTRATOR
        status: PENDING
        created_at: '2022-01-17T10:12:25Z'
        created_by: MAN Administrator <support@man-platform>
        updated_at: '2022-01-17T10:12:25Z'
        updated_by: MAN Administrator <support@man-platform>
    ResendActivationLinkRequestUsingUserId:
      summary: Request new activation link using a user ID (MAN_ADMINISTRATOR / ADMINISTRATOR only)
      value:
        user_id: 155720a6-f4c9-40ec-b479-a32d7f062553
        activation_link: true
    Ticket:
      value:
        id: 24fa2014-8b50-4159-a250-789ebf4500e6
        issue_type: INCIDENT
        communication_type: VOICE
        typology_code: 2A
        category: Constatation ou suspicion d'usurpation de numéro
        typology_label: Numéro appelant usurpé (suite à vérification)
        description: Ce n'est pas la première fois
        source: PROVIDER
        number_of_communications: 1
        provider_author_role: SIGNATORY_OPTS
        next_action_required_by: OPE2
        signatory: OPE1
        opts: OPTS
        ingress_provider: OPE3
        egress_provider: OPE3
        termination_provider: TERM
        optv: OPTV
        display_number: 102030406
        display_number_type: LANDLINE
        has_identity_header: true
        is_sti_vs_valid: true
        called_number: 102030407
        call_timestamp: 1660742563701
        shaken_attestation_value: A
        last_known_interconnection: SIP
        sip_reject_code: ''
        sip_reject_sub_code: ''
        is_emergency_call: false
        calling_number: 102030408
        is_reoccurring_issue: false
        is_related_to_single_called_customer: false
        estimated_issue_date: '2022-01-17T10:12:25Z'
        is_call_breakable: false
        is_call_broken: false
        provider_author_apnf_code: OPE100
        status: OPEN
        resolution: null
        creation_date: '2022-01-17T10:12:25Z'
        creation_author: 61757468-6f72-2d31-3030-000000000000
        modification_date: '2022-01-17T10:12:25Z'
        modification_author: 61757468-6f72-2d31-3030-000000000123
        criticality: 2
        reference_id: 1
    TicketClosed:
      value:
        id: 24fa2014-8b50-4159-a250-789ebf4500e6
        issue_type: INCIDENT
        communication_type: VOICE
        typology_code: 2A
        category: Constatation ou suspicion d'usurpation de numéro
        typology_label: Numéro appelant usurpé (suite à vérification)
        description: Ce n'est pas la première fois
        source: PROVIDER
        number_of_communications: 1
        provider_author_role: SIGNATORY_OPTS
        next_action_required_by: OPE2
        signatory: OPE1
        opts: OPTS
        ingress_provider: OPE3
        egress_provider: OPE3
        termination_provider: TERM
        optv: OPTV
        display_number: 102030406
        display_number_type: LANDLINE
        has_identity_header: true
        is_sti_vs_valid: true
        called_number: 102030407
        call_timestamp: 1660742563701
        shaken_attestation_value: A
        last_known_interconnection: SIP
        sip_reject_code: ''
        sip_reject_sub_code: ''
        is_emergency_call: false
        calling_number: 102030408
        is_reoccurring_issue: false
        is_related_to_single_called_customer: false
        estimated_issue_date: '2022-01-17T10:12:25Z'
        is_call_breakable: false
        is_call_broken: false
        provider_author_apnf_code: OPE100
        status: CLOSED
        resolution: FIXED
        creation_date: '2022-01-17T10:12:25Z'
        creation_author: 61757468-6f72-2d31-3030-000000000000
        modification_date: '2022-01-17T10:12:25Z'
        modification_author: 61757468-6f72-2d31-3030-000000000123
        criticality: 2
        reference_id: 1
    TicketComment:
      value:
        text: this is my comment
        provider_author_apnf_code: OPE100
        creation_date: '2022-01-17T10:12:25Z'
    TicketPatch:
      value:
        next_action_required_by: OPE100
        signatory: OPE100
        opts: OPE200
        ingress_provider: OPE300
        egress_provider: OPE300
        termination_provider: OPE400
        optv: OPE500
    UserCreationRequestByManAdministrator:
      summary: Creation of an APNF user by platform administrator
      value:
        firstname: Mark
        lastname: Jones
        email_address: mark.jones@apnf
        roles:
          - APNF
        mobile_phone: '+33612345678'
    UserPersonalUpdateRequest:
      summary: Request to update all possible properties for one's own account
      value:
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        mobile_phone: '+33612345678'
        language: ENGLISH
    UserUpdateRequest:
      summary: Request to update all possible properties for another account
      value:
        firstname: Jane
        lastname: Doe
        email_address: jane.doe@spa.domain
        mobile_phone: '+33612345678'
        language: ENGLISH
        roles:
          - ADMINISTRATOR
        status: DISABLED
  headers:
    Cache-Control:
      description: Header used to define cache to be set for the entry.
      schema:
        type: string
        example: public, max-age=86400, must-revalidate
    Content-Length:
      description: Size in bytes of the response body.
      schema:
        type: integer
        example: 80
    Content-Type-GZip:
      description: Content-Type header set as "application/gzip".
      schema:
        type: string
        example: application/gzip
    Content-Type-Pkix-Crl:
      description: Content-Type header set as "application/pkix-crl".
      schema:
        type: string
        example: application/pkix-crl
    Location-Certificate:
      description: Certificate access URL in the BPCO.
      schema:
        type: string
        example: https://api.man-bpco.fr/certs/SPC000/a44cbe3916e8cd6e.cer
    X-Correlation-Id:
      description: ID generated by the API gateway.
      schema:
        $ref: '#/components/schemas/UUID'
      example: f13371a6-40d7-48cf-a221-794b63fddbd9
    X-Response-Id:
      description: Response ID that corresponds to the `X-Request-Id` request header, if provided.
      schema:
        $ref: '#/components/schemas/UUID'
      example: 68831c50-2953-4047-9935-81a98ac1e1e1
  parameters:
    CallTraceAttestationFilter:
      name: attestation
      in: query
      description: Filter by SHAKEN attestation level
      required: false
      schema:
        type: string
    CallTraceAuthorProviderFilter:
      name: author_provider
      in: query
      description: Filter by author provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    CallTraceAuthorProviderRoleFilter:
      name: author_provider_role
      in: query
      description: Filter by role of the provider who made the trace
      required: false
      schema:
        type: string
    CallTraceBrokenCallFilter:
      name: broken_call
      in: query
      description: Filter by broken call status
      required: false
      schema:
        type: string
        enum:
          - 'yes'
          - 'no'
      example: 'yes'
    CallTraceCalledNumberFilter:
      name: called_number
      in: query
      description: Filter by truncated called phone number (4 last digits)
      required: false
      schema:
        type: string
        pattern: ^[0-9]{4}$
      example: '9012'
    CallTraceCalledNumberTypeFilter:
      name: called_number_type
      in: query
      description: Filter by type of the called number
      required: false
      schema:
        type: string
    CallTraceDisplayedNumberFilter:
      name: displayed_number
      in: query
      description: Filter by truncated displayed phone number (4 last digits or special value)
      required: false
      schema:
        type: string
        pattern: ^([0-9]{4}|anonymous|unavailable|invalid)$
      example: '1234'
    CallTraceDisplayedNumberTypeFilter:
      name: displayed_number_type
      in: query
      description: Filter by type of the displayed number
      required: false
      schema:
        type: string
    CallTraceEgressProviderFilter:
      name: egress_provider
      in: query
      description: Filter by egress provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    CallTraceEmergencyCallFilter:
      name: emergency_call
      in: query
      description: Filter by emergency call status
      required: false
      schema:
        type: string
    CallTraceExcludeSelfAuthorFilter:
      name: exclude_self_author
      in: query
      description: Filter to exclude traces where author_provider equals current user's provider
      required: false
      schema:
        type: string
        enum:
          - 'yes'
          - 'no'
      example: 'yes'
    CallTraceIdentityHeaderFilter:
      name: identity_header
      in: query
      description: Filter by presence of identity header
      required: false
      schema:
        type: string
        enum:
          - 'yes'
          - 'no'
      example: 'yes'
    CallTraceIngressProviderFilter:
      name: ingress_provider
      in: query
      description: Filter by ingress provider (APNF code or 'unknown')
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6}|unknown)$
      example: OPC000
    CallTraceOptsFilter:
      name: opts
      in: query
      description: Filter by OPTS provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPTS00
    CallTraceOptvFilter:
      name: optv
      in: query
      description: Filter by OPTV provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPTV00
    CallTracePaiFilter:
      name: pai
      in: query
      description: Filter by truncated PAI phone number (4 last digits)
      required: false
      schema:
        type: string
        pattern: ^[0-9]{4}$
      example: '5678'
    CallTraceProviderDisengagementFilter:
      name: provider_disengagement
      in: query
      description: Filter by provider disengagement status
      required: false
      schema:
        type: string
        enum:
          - 'yes'
          - 'no'
      example: 'no'
    CallTraceProviderFilter:
      name: provider
      in: query
      description: Filter by provider responsible for the trace (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    CallTraceSearchTypeFilter:
      name: search_type
      in: query
      description: |
        Special search type:
        - `sip_428`: returns traces from ANY provider where sip_reject_code = 428
        - `disengaged`: returns traces from ANY provider where provider_disengagement = yes
      required: false
      schema:
        type: string
        enum:
          - sip_428
          - disengaged
      example: sip_428
    CallTraceSearchedProviderFilter:
      name: searched_provider
      in: query
      description: |
        Filter by searched provider (APNF code).
        Only available for MAN_ADMINISTRATOR and APNF users.
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    CallTraceSearchedProviderRoleFilter:
      name: searched_provider_role
      in: query
      description: |
        Filter by role of the searched provider.
        Only available for MAN_ADMINISTRATOR and APNF users.
      required: false
      schema:
        type: string
    CallTraceSignatoryProviderFilter:
      name: signatory_provider
      in: query
      description: Filter by signatory provider (APNF code or 'unknown')
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6}|unknown)$
      example: OPC000
    CallTraceSipRejectCodeFilter:
      name: sip_reject_code
      in: query
      description: Filter by SIP reject code
      required: false
      schema:
        type: integer
      example: 436
    CallTraceSipRejectSubcodeFilter:
      name: sip_reject_subcode
      in: query
      description: Filter by SIP reject subcode
      required: false
      schema:
        type: string
      example: Bad Identity Info
    CallTraceStartCallTimestampFilter:
      name: start_call_timestamp
      in: query
      description: Filter by timestamp of the call start (ISO-8601 format)
      required: false
      schema:
        type: string
        format: date-time
      example: '2023-01-17T10:12:25Z'
    CallTraceTerminatingProviderFilter:
      name: terminating_provider
      in: query
      description: Filter by terminating provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: TERM00
    CertificateCreatedAtFilter:
      name: created_at
      in: query
      description: Filter by creation date
      required: false
      schema:
        type: string
        format: date-time
    CertificateId:
      name: certificate_id
      in: path
      description: ID of the certificate to retrieve history records
      required: true
      example: d240dd9e-a077-42f5-92e3-a3d3f10e002e
      schema:
        $ref: '#/components/schemas/UUID'
    CertificateIdFilter:
      name: id
      in: query
      description: Filter by certificate ID
      required: false
      schema:
        type: string
        format: uuid
    CertificateNameFilter:
      name: name
      in: query
      description: Filter by certificate name
      required: false
      schema:
        type: string
    CertificateOptsFilter:
      name: opts
      in: query
      description: Filter by OPTS provider (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
    CertificateProviderIdFilter:
      name: provider_id
      in: query
      description: Filter by provider ID (only for MAN_ADMINISTRATOR and APNF users)
      required: false
      schema:
        type: string
        format: uuid
    CertificateRenewalAfterFilter:
      name: renewal_after
      in: query
      description: Filter by renewal after days
      required: false
      schema:
        type: integer
    CertificateRenewalAutoFilter:
      name: renewal_auto
      in: query
      description: Filter by automatic renewal flag
      required: false
      schema:
        type: string
    CertificateRevokedAtFilter:
      name: revoked_at
      in: query
      description: Filter by revocation date
      required: false
      schema:
        type: string
        format: date-time
    CertificateRevokedReasonFilter:
      name: revoked_reason
      in: query
      description: Filter by revocation reason
      required: false
      schema:
        type: string
    CertificateSnFilter:
      name: sn
      in: query
      description: Filter by serial number
      required: false
      schema:
        type: string
    CertificateStatusFilter:
      name: status
      in: query
      description: Filter by certificate status
      required: false
      schema:
        type: string
    CertificateTestCertificateFilter:
      name: test_certificate
      in: query
      description: Filter by test certificate flag
      required: false
      schema:
        type: string
    CertificateTypeFilter:
      name: type
      in: query
      description: Filter by certificate type
      required: false
      schema:
        type: string
    CertificateUpdatedAtFilter:
      name: updated_at
      in: query
      description: Filter by last update date
      required: false
      schema:
        type: string
        format: date-time
    CertificateValidFromFilter:
      name: valid_from
      in: query
      description: Filter by validity start date
      required: false
      schema:
        type: string
        format: date-time
    CertificateValidToFilter:
      name: valid_to
      in: query
      description: Filter by expiration date
      required: false
      schema:
        type: string
        format: date-time
    ClientInternalIdFilter:
      name: client_internal_id
      in: query
      description: |
        Filter by client internal ID.

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 128
      example: CLIENT-SI054
    CredentialClientIdFilter:
      name: client_id
      in: query
      description: Filter by client ID
      required: false
      schema:
        type: string
    CredentialCreatedAtFilter:
      name: created_at
      in: query
      description: Filter by creation date
      required: false
      schema:
        type: string
        format: date-time
    CredentialExpiresOnFilter:
      name: expires_on
      in: query
      description: Filter by expiration date
      required: false
      schema:
        type: string
        format: date-time
    CredentialId:
      name: credential_id
      in: path
      description: ID of the credential to retrieve the history records
      required: true
      example: 9152f121-f66f-421c-87ce-78b218e250d4
      schema:
        $ref: '#/components/schemas/UUID'
    CredentialIdFilter:
      name: id
      in: query
      description: Filter by credential ID
      required: false
      schema:
        type: string
        format: uuid
    CredentialLastUsedAtFilter:
      name: last_used_at
      in: query
      description: Filter by last used date
      required: false
      schema:
        type: string
        format: date-time
    CredentialNameFilter:
      name: name
      in: query
      description: Filter by credential name (partial match)
      required: false
      schema:
        type: string
    CredentialProviderIdFilter:
      name: provider_id
      in: query
      description: Filter by provider ID (only for MAN_ADMINISTRATOR and APNF users)
      required: false
      schema:
        type: string
        format: uuid
    CredentialUpdatedAtFilter:
      name: updated_at
      in: query
      description: Filter by last update date
      required: false
      schema:
        type: string
        format: date-time
    DelegateeCreatedAtFilter:
      name: created_at
      in: query
      description: |
        Filter by creation date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2022-01-01T00:00:00Z'
    DelegateeId:
      name: delegatee_id
      in: path
      description: Delegatee unique ID
      required: true
      example: 155720a6-f4c9-40ec-b479-a32d7f062553
      schema:
        $ref: '#/components/schemas/UUID'
    DelegateeIdFilter:
      name: delegatee_id
      in: query
      description: |
        Filter by delegatee ID.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: uuid
      example: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
    DelegateeRevokedAtFilter:
      name: revoked_at
      in: query
      description: |
        Filter by revocation date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2022-01-01T00:00:00Z'
    DelegateeStatusFilter:
      name: status
      in: query
      description: |
        Filter by delegatee status.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        enum:
          - ACTIVE
          - REVOKED
      example: ACTIVE
    DelegationCntFilter:
      name: delegation_cnt
      in: query
      description: |
        Filter by number of active delegations.

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: integer
        minimum: 0
      example: 5
    DelegationCreatedAtFilter:
      name: created_at
      in: query
      description: |
        Filter by creation date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2024-01-15T10:30:00Z'
    DelegationDelegateeIdFilter:
      name: delegatee_id
      in: query
      description: |
        Filter by delegatee ID.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: uuid
      example: d4f7564e-cbf6-45c3-88db-8b4df159eaf6
    DelegationRequestIdFilter:
      name: delegation_request_id
      in: query
      description: |
        Filter by delegation request ID.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: uuid
      example: a3f2564e-cbf6-45c3-88db-8b4df159eaf7
    DelegationRevokedAtFilter:
      name: revoked_at
      in: query
      description: |
        Filter by revocation date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2024-02-01T09:00:00Z'
    DelegationStatusFilter:
      name: status
      in: query
      description: |
        Filter by delegation status.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        enum:
          - ACTIVE
          - REVOKED
          - EXPIRED
      example: ACTIVE
    DelegationUpdatedAtFilter:
      name: updated_at
      in: query
      description: |
        Filter by last update date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2024-01-16T14:20:00Z'
    ExpirationDateFilter:
      name: expiration_date
      in: query
      description: |
        Filter by expiration date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2025-12-31T23:59:59Z'
    If-Modified-Since:
      name: If-Modified-Since
      in: header
      description: Date in HTTP-Date format (RFC 7231).
      required: false
      schema:
        $ref: '#/components/schemas/RFC7231.HTTP-date'
    IsmProviderEmitterCodeFilter:
      name: provider_emitter_code
      in: query
      description: Filter by provider emitter code (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    IsmProviderEmitterStatusFilter:
      name: provider_emitter_status
      in: query
      description: Filter by provider emitter status
      required: false
      schema:
        type: string
    IsmProviderReceiverCodeFilter:
      name: provider_receiver_code
      in: query
      description: Filter by provider receiver code (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: SPB000
    IsmProviderReceiverStatusFilter:
      name: provider_receiver_status
      in: query
      description: Filter by provider receiver status
      required: false
      schema:
        type: string
    MeteoCriticalityFilter:
      name: criticality
      in: query
      description: Filter by criticality level of the meteo event
      required: false
      schema:
        type: string
    MeteoEndDateFilter:
      name: end_date
      in: query
      description: Filter meteo until this end date (ISO-8601 format)
      required: false
      schema:
        type: string
        format: date-time
      example: '2023-12-31T23:59:59Z'
    MeteoProviderAuthorApnfCodeFilter:
      name: provider_author_apnf_code
      in: query
      description: Filter by provider author (APNF code)
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPC000
    MeteoStartDateFilter:
      name: start_date
      in: query
      description: Filter meteo from this start date (ISO-8601 format)
      required: false
      schema:
        type: string
        format: date-time
      example: '2023-01-01T00:00:00Z'
    MeteoTagsFilter:
      name: tags
      in: query
      description: Filter by tags (MAN elements involved in the event)
      required: false
      schema:
        type: string
    OpeFilter:
      name: ope
      in: query
      description: |
        Filter by OPE (APNF only).

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 6
      example: OPC000
    OpeInformationFilter:
      name: ope_information
      in: query
      description: |
        Filter by OPE information (OPE only).

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 1024
      example: Lorem ipsum...
    OspClientInternalIdFilter:
      name: osp_client_internal_id
      in: query
      description: |
        Filter by OSP internal client identifier (OSP only).

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 128
      example: client_123
    OspFilter:
      name: osp
      in: query
      description: |
        Filter by OSP (APNF only).

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 6
      example: OPC001
    PaginationLimit:
      name: limit
      in: query
      description: 'Number of records to return (Max: 100)'
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 100
        default: 20
    PaginationOffset:
      name: offset
      in: query
      description: Offset to start the pagination
      required: false
      schema:
        type: integer
        default: 0
    ProviderId:
      name: provider_id
      in: path
      description: ID of the provider
      required: true
      example: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
      schema:
        $ref: '#/components/schemas/UUID'
    RoleFilter:
      name: role
      in: query
      description: |
        Filter by user role. (Providers only)

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        enum:
          - OPE
          - OSP
          - OPE/OSP
      example: OPE
    TicketAuthorInternalIdFilter:
      name: author_ticket_internal_id
      in: query
      description: |
        Filter by ticket author's internal ID.

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
        maxLength: 128
      example: My_Internal_ID123
    TicketCommunicationTypeFilter:
      name: communication_type
      in: query
      description: Filter by communication type
      required: false
      schema:
        type: string
    TicketCreationDateFilter:
      name: creation_date
      in: query
      description: |
        Filter by creation date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `gtn`, `gten`, `ltn`, `lten`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2022-01-01T00:00:00Z'
    TicketCriticalityFilter:
      name: criticality
      in: query
      description: |
        Filter by ticket criticality (1-3).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 3
      example: 2
    TicketId:
      name: ticket_id
      in: path
      description: reference id to the ticket (integer).
      required: true
      schema:
        type: integer
    TicketIssueTypeFilter:
      name: issue_type
      in: query
      description: |
        Filter by issue type.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        enum:
          - INCIDENT
      example: INCIDENT
    TicketModificationDateFilter:
      name: modification_date
      in: query
      description: |
        Filter by modification date (ISO-8601 format).

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `gtn`, `gten`, `ltn`, `lten`, `in`, `not_in`
      required: false
      schema:
        type: string
        format: date-time
      example: '2022-01-01T00:00:00Z'
    TicketNextActionRequiredByFilter:
      name: next_action_required_by
      in: query
      description: |
        Filter by provider code assigned to the ticket.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketProviderAuthorApnfCodeFilter:
      name: provider_author_apnf_code
      in: query
      description: |
        Filter by provider author APNF code.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketReferenceIdFilter:
      name: reference_id
      in: query
      description: |
        Filter by ticket reference ID.

        **Operators:** `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: integer
      example: 123
    TicketStatusFilter:
      name: status
      in: query
      description: |
        Filter by ticket status.

        **Operators:** `eq`, `ne`, `in`, `not_in`
      required: false
      schema:
        type: string
        enum:
          - OPEN
          - IN_PROGRESS
          - CLOSED
      example: OPEN
    TicketTypologyCodeFilter:
      name: typology_code
      in: query
      description: |
        Filter by typology code.

        **Operators:** `eq`, `ne`, `match`, `not_match`, `in`, `not_in`
      required: false
      schema:
        type: string
      example: D1
    Tn:
      name: tn
      in: path
      required: true
      description: |
        Telephone number. The format is defined in the `Mode opératoire de la délégation d'affichage` document, but can be defined as following:

        `CC(C)ZABPQMCDUαβγ(δ)`, where at least the following constraints are defined:

        - `CC(C)` is the country code using 2 or 3 digits. The allowed values are: 33, 590, 594, 596, 262 and 508.
        - `Z` cannot be set to 6 or 7
        - `ZA` cannot be set to 89
      schema:
        type: integer
        pattern: ^([1-9][0-9]{1,14})$
        example: 33123456789
    TnEndFilter:
      name: tn_end
      in: query
      description: |
        Filter by end telephone number.

        **Operators:** `eq`, `ne`, `match`, `not_match`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        pattern: ^[0-9]{4,15}$
      example: '33123456799'
    TnStartFilter:
      name: tn_start
      in: query
      description: |
        Filter by start telephone number.

        **Operators:** `eq`, `ne`, `match`, `not_match`, `gt`, `gte`, `lt`, `lte`, `in`, `not_in`
      required: false
      schema:
        type: string
        pattern: ^[0-9]{4,15}$
      example: '33123456789'
    UserCreatedAtFilter:
      name: created_at
      in: query
      description: Filter by creation date
      required: false
      schema:
        type: string
        format: date-time
    UserDeletedAtFilter:
      name: deleted_at
      in: query
      description: Filter by deletion date
      required: false
      schema:
        type: string
        format: date-time
    UserDeletedFilter:
      name: deleted
      in: query
      description: Filter by deleted flag
      required: false
      schema:
        type: string
    UserEmailAddressFilter:
      name: email_address
      in: query
      description: Filter by user email address
      required: false
      schema:
        type: string
    UserFirstnameFilter:
      name: firstname
      in: query
      description: Filter by user first name
      required: false
      schema:
        type: string
    UserId:
      name: user_id
      in: path
      description: ID of the user
      required: true
      example: 155720a6-f4c9-40ec-b479-a32d7f062553
      schema:
        $ref: '#/components/schemas/UUID'
    UserIdFilter:
      name: id
      in: query
      description: Filter by user ID
      required: false
      schema:
        type: string
        format: uuid
    UserLanguageFilter:
      name: language
      in: query
      description: Filter by user language preference
      required: false
      schema:
        type: string
    UserLastConnectedAtFilter:
      name: last_connected_at
      in: query
      description: Filter by last connection date
      required: false
      schema:
        type: string
        format: date-time
    UserLastnameFilter:
      name: lastname
      in: query
      description: Filter by user last name
      required: false
      schema:
        type: string
    UserProviderIdFilter:
      name: provider_id
      in: query
      description: Filter by provider ID (only for MAN_ADMINISTRATOR and APNF users)
      required: false
      schema:
        type: string
        format: uuid
    UserRolesFilter:
      name: roles
      in: query
      description: |
        Filter by user role using the format `operator:value`.
        - Operator: `has` (only supported operator)
        - Value: One of the available roles (ADMINISTRATOR, MANAGER, SUPERVISOR, DELEGATION_MANAGER, DELEGATION_SUPERVISOR, MAN_ADMINISTRATOR, APNF)

        Example: `has:DELEGATION_MANAGER`
      required: false
      schema:
        type: string
        example: has:ADMINISTRATOR
    UserStatusFilter:
      name: status
      in: query
      description: Filter by user status
      required: false
      schema:
        type: string
    UserUpdatedAtFilter:
      name: updated_at
      in: query
      description: Filter by last update date
      required: false
      schema:
        type: string
        format: date-time
    X-Request-Id:
      name: X-Request-Id
      in: header
      description: Request ID that will be returned into the `X-Response-Id` response header.
      required: false
      schema:
        $ref: '#/components/schemas/UUID'
      example: 68831c50-2953-4047-9935-81a98ac1e1e1
  responses:
    ErrorCertificateValidation:
      description: Returned when the certificate request input validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: BAD_REQUEST
            message: The request validation failed.\n\t`field1` <error_details>, `field2` <error_details>
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorConflict:
      description: Returned when the API request cannot be fulfilled due to the object current status.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: CONFLICT
            message: This resource already exists.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorInternal:
      description: Returned when an unexpected error occurred while processing the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: INTERNAL_SERVER_ERROR
            message: An unexpected error occurred while processing the request.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorInternalNoContents:
      description: Returned when an unexpected error occurred while processing the request.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorInvalidAcceptHeader:
      description: Returned when the client specifies a type not supported by the platform in the `Accept` HTTP header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: NOT_ACCEPTABLE
            message: The format in the `Accept` header is not supported.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorInvalidAcceptHeaderNoContents:
      description: Returned when the client specifies a type not supported by the platform in the `Accept` HTTP header.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorInvalidContentType:
      description: Returned when the client specifies a `Content-Type` header value not supported.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: UNSUPPORTED_MEDIA_TYPE
            message: The format of the request body is not supported.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNoPermission:
      description: Returned when the client does not have the expected permissions to access the method.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: FORBIDDEN
            message: User is not allowed to access this resource.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNoPermissionNoContents:
      description: Returned when the client does not have the expected permissions to access the method.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNotAllowed:
      description: Error returned when the API method is not allowed for the given object.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: METHOD_NOT_ALLOWED
            message: The method is not allowed for the resource.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNotAuthenticated:
      description: Returned when the client authentication failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: UNAUTHORIZED
            message: The authentication failed.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNotAuthenticatedNoContents:
      description: Returned when the client authentication failed.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorNotFound:
      description: Returned when the object referenced by the API request does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: NOT_FOUND
            message: The resource is not found.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorRateLimiting:
      description: Returned when too many requests have been sent by the client in a certain amount of time.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: TOO_MANY_REQUESTS
            message: Rate limit is exceeded.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorRateLimitingNoContents:
      description: Returned when too many requests have been sent by the client in a certain amount of time.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ErrorValidation:
      description: Returned when the request input validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: BAD_REQUEST
            message: The request validation failed.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ServiceUnavailable:
      description: Returned when the service is unavailable (e.g. maintenance mode) and cannot process the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiPayloadError'
          example:
            code: SERVICE_UNAVAILABLE
            message: The service is currently unavailable.
      headers:
        Content-Length:
          $ref: '#/components/headers/Content-Length'
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    ServiceUnavailableNoContents:
      description: Returned when the service is unavailable (e.g. maintenance mode) and cannot process the request.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
    SuccessNoMessage:
      description: Confirms successful processing. No contents are provided.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/X-Correlation-Id'
        X-Response-Id:
          $ref: '#/components/headers/X-Response-Id'
  schemas:
    ApiCredential:
      type: object
      description: |
        API credential data model.
        Contains the `client_id` (without `client_secret`) data to be used in OAuth 2.0 authorization API call for
        access token delivery.
      required:
        - id
        - provider_id
        - name
        - client_id
        - perimeter
        - created_at
        - created_by
        - updated_at
        - updated_by
      properties:
        id:
          $ref: '#/components/schemas/CredentialId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the credential.
            - $ref: '#/components/schemas/ProviderId'
        name:
          type: string
          maxLength: 64
          description: Name of the API credential
          example: 'API Credential SI #1'
        client_id:
          type: string
          description: data to be passed to the OAuth 2.0 authorization call to get a new access token.
        perimeter:
          type: array
          description: List of the perimeters granted to the credential
          items:
            $ref: '#/components/schemas/Perimeter'
        description:
          type: string
          maxLength: 1024
          description: Additional information
          example: Description of the credential.
        expires_on:
          type: string
          description: |
            Credential expiration date. Date shall be in ISO-8601 format.
            When expired, no more access tokens can be delivered using the `client_id` and `client_secret` data
            associated with this credential
          format: date-time
          example: '2022-01-24T10:12:25Z'
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            User who created the credential. Format shall be `<first name> <last name> <<email address>>`.
            May otherwise be set to `API` if the update has been triggered by an API call or `SYSTEM` if the action
            is performed by the platform.
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: |
            Last Update Date.
            Initially set to the same value as `created_at`.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            User who updated the credential settings. Format shall be `<first name> <last name> <<email address>>`.
            May otherwise be set to `API` if the update has been triggered by an API call or `SYSTEM` if the action
            is performed by the platform.
            Initially set to the same value as `created_by`.
          example: John Doe <john.doe@spa.domain>
        last_used_at:
          type: string
          description: Date the API credential has been last used to deliver an access token.
          format: date-time
          example: '2022-01-20T10:12:25Z'
    ApiCredentialCreationRequest:
      type: object
      description: Provider (to create) data model
      required:
        - name
        - perimeter
      properties:
        name:
          type: string
          maxLength: 64
          description: Name of the credential
          example: 'API Credential SI #1'
        perimeter:
          type: array
          description: List of the perimeters granted to the credential
          items:
            $ref: '#/components/schemas/Perimeter'
        description:
          type: string
          maxLength: 1024
          description: Optional information
          example: Description of the credential.
        expires_on:
          type: string
          description: |
            Credential expiration date. Date shall be in ISO-8601 format.

            When expired, no more access tokens can be delivered using the `client_id` and `client_secret` data
            associated with this credential
          format: date-time
          example: '2022-01-24T10:12:25Z'
    ApiCredentialCreationResponse:
      allOf:
        - $ref: '#/components/schemas/ApiCredential'
        - type: object
          description: |
            API credential data model.
            Contains the `client_id` and `client_secret` data to be used in OAuth 2.0 authorization API call for
            access token delivery.
          required:
            - client_secret
          properties:
            client_secret:
              type: string
              maxLength: 32
              description: |
                data to be passed to the OAuth 2.0 authorization call to get a new access token.
    ApiCredentialSummaryView:
      type: object
      description: |
        API credential data model (summary view).
        Contains the `client_id` (without `client_secret`) data to be used in OAuth 2.0 authorization API call for
        access token delivery.
      required:
        - id
        - provider_id
        - name
        - client_id
        - perimeter
        - created_at
        - updated_at
      properties:
        id:
          $ref: '#/components/schemas/CredentialId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the credential.
            - $ref: '#/components/schemas/ProviderId'
        name:
          type: string
          maxLength: 64
          description: Name of the API credential
          example: 'API Credential SI #1'
        client_id:
          type: string
          maxLength: 64
          description: data to be passed to the OAuth 2.0 authorization call to get a new access token.
        perimeter:
          type: array
          description: List of the perimeters granted to the credential
          items:
            $ref: '#/components/schemas/Perimeter'
        expires_on:
          type: string
          description: |
            Credential expiration date. Date shall be in ISO-8601 format.
            When expired, no more access tokens can be delivered using the `client_id` and `client_secret` data
            associated with this credential
          format: date-time
          example: '2022-01-24T10:12:25Z'
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_at:
          type: string
          description: |
            Last Update Date.
            Initially set to the same value as `created_at`.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        last_used_at:
          type: string
          description: Date the API credential has been last used to deliver an access token.
          format: date-time
          example: '2022-01-20T10:12:25Z'
    ApiPayloadError:
      type: object
      description: Data model for error responses.
      required:
        - code
        - message
      properties:
        code:
          type: string
          maxLength: 64
          description: Error code. Shall be capitalized with underscores.
        message:
          type: string
          maxLength: 1024
          description: Message providing more details and context for the error that occurred.
        errors:
          type: string
          description: 'Message providing machine-readable details about the errors. Pattern is `field`: <field_value|[field_values]>'
          example: '`tns`: [tn1, tn2, ...]'
    ApiPayloadListError:
      type: array
      description: Data model for multiple error responses.
      items:
        $ref: '#/components/schemas/ApiPayloadError'
    ArchivedCertificateStatus:
      type: string
      description: Archived Certificate status. Allowed values are a subset of those accepted for `CertificateStatus` schema.
      enum:
        - REVOKED
        - EXPIRED
        - INVALID
      example: EXPIRED
    ArchivedCertificateSummaryView:
      type: object
      description: |
        Archived Certificate data model (summary view). This model will be used for both active and archived certificates.
      required:
        - id
        - provider_id
        - type
        - name
        - valid_from
        - valid_to
        - test_certificate
        - status
        - archived
        - renewal_auto
      properties:
        id:
          $ref: '#/components/schemas/CertificateId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the certificate.
            - $ref: '#/components/schemas/ProviderId'
        type:
          $ref: '#/components/schemas/CertificateType'
        opts:
          type: string
          description: |
            APNF Code of the technical signing service provider (OPTS). Mandatory when certificate `type` is `INDIRECT`,
            `null` otherwise.
          pattern: ^([0-9A-Z]{6})$
          example: SPB000
        name:
          type: string
          maxLength: 64
          description: |
            Certificate name provided by the origin service provider. Used to construct certificate Common Name.
          example: Main Certificate
        valid_from:
          type: string
          description: Certificate validity start date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        valid_to:
          type: string
          description: Certificate expiration date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
        test_certificate:
          type: boolean
          description: Is this a test certificate?
          example: false
        url:
          type: string
          maxLength: 2048
          description: URL of the certificate in the certificate public repository
          example: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        status:
          $ref: '#/components/schemas/ArchivedCertificateStatus'
        archived:
          type: boolean
          description: Has the certificate been archived?
          example: true
        renewal_auto:
          type: boolean
          description: |
            Automated renewal option. If enabled, the application will create a new certificate using the same CSR and
            options provided for this certificate.
          example: true
        sn:
          type: string
          description: Certificate serial number
          pattern: ^([0-9A-Fa-f]{16,40})$
          example: 57ABB34BCA510043BDE438460F13B27E6A82C004
    BypassToken:
      type: object
      required:
        - id
        - created_at
      properties:
        id:
          $ref: '#/components/schemas/BypassTokenId'
        created_at:
          type: string
          description: |
            Token creation date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        archived_at:
          type: string
          description: |
            Token archiving date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
    BypassTokenCreationResponse:
      type: object
      description: Response of bypass token generation request
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/BypassTokenId'
    BypassTokenId:
      type: string
      pattern: ^([0-9A-Z]{6})-([0-9A-Z\-]{16})$
      description: |
        Current token to be used by provider in "Identity-Bypass" SIP INVITE message header
        when the provider has to temporarily disable its STI-AS component.

        The expected format is `SPC-RANDOM`, where:
        - SPC: APNF Service Provider Code
        - RANDOM: 1 to 16 characters between A-Z, 0-A or '-'
      example: SPC000-YE42L73SGAG45I05
    Certificate:
      type: object
      description: Certificate data model. This model will be used for both active and archived certificates.
      required:
        - id
        - provider_id
        - type
        - name
        - valid_from
        - valid_to
        - test_certificate
        - status
        - archived
        - renewal_auto
        - created_at
        - created_by
        - updated_at
        - updated_by
      properties:
        id:
          $ref: '#/components/schemas/CertificateId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the certificate.
            - $ref: '#/components/schemas/ProviderId'
        type:
          $ref: '#/components/schemas/CertificateType'
        opts:
          type: string
          description: |
            APNF Code of the technical signing service provider (OPTS). Mandatory when certificate `type` is `INDIRECT`,
            `null` otherwise.
          pattern: ^([0-9A-Z]{6})$
          example: SPB000
        name:
          type: string
          maxLength: 64
          description: |
            Certificate name provided by the origin service provider. Used to construct certificate Common Name.
          example: Main Certificate
        description:
          type: string
          maxLength: 1024
          description: Additional information related to the certificate
          example: Description of the certificate.
        valid_from:
          type: string
          description: Certificate validity start date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        valid_to:
          type: string
          description: Certificate expiration date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
        test_certificate:
          type: boolean
          description: Is this a test certificate?
          example: false
        status:
          $ref: '#/components/schemas/CertificateStatus'
        archived:
          type: boolean
          description: Has the certificate been archived?
          example: false
        renewal_auto:
          type: boolean
          description: |
            Automated renewal option. If enabled, the application will create a new certificate using the same CSR and
            options provided for this certificate.
          example: true
        renewal_after:
          type: integer
          description: |
            Number of days after certificate validity start date to wait
            for the automated certificate renewal process to be triggered.
            Set only if `renewal_auto` is set to `true`.
          example: 300
        renewed_by:
          allOf:
            - description: ID of the new certificate that replaces this certificate.
            - $ref: '#/components/schemas/UUID'
        url:
          type: string
          maxLength: 2048
          description: URL of the certificate in the certificate public repository
          example: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        sn:
          type: string
          description: Certificate serial number
          pattern: ^([0-9A-Fa-f]{16,40})$
          example: 57ABB34BCA510043BDE438460F13B27E6A82C004
        contents:
          type: string
          maxLength: 2048
          description: Certificate contents in PEM format.
          example: |
            -----BEGIN CERTIFICATE-----
            MIIC/DCCAqOgAwIBAgIUV6uzS8pRAEO95DhGDxOyfmqCwAQwCgYIKoZIzj0EAwIw
            gYcxLDAqBgNVBAMMI0JQQ08gQ0ExIMOiwoDCkyBTSEFLRU4gSW50ZXJtZWRpYXRl
            MQswCQYDVQQGEwJGUjEqMCgGA1UECgwhQmFzZSBkZXMgQ2VydGlmaWNhdHMgT3DD
            g8KpcmF0ZXVyMR4wHAYDVQQLDBVDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcNMjIw
            NzA0MTAwMDMxWhcNMjIxMDAyMTAwMDMxWjBXMRYwFAYDVQQDDA1TSEFLRU4gT1BD
            MDAwMQswCQYDVQQGEwJGUjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQL
            DBBTZXJ2aWNlIFByb3ZpZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/
            qQeNfCytgqjIETfjmVEw7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0
            ULplSrl9+QrrpKLwjKOCARowggEWMB0GA1UdDgQWBBRk53mcS8XiTcavdh4VBd3j
            RA803zAfBgNVHSMEGDAWgBRNelLrS9FcVoyWR7d8FHJRlixuBDAOBgNVHQ8BAf8E
            BAMCB4AwDAYDVR0TAQH/BAIwADCBmwYDVR0fBIGTMIGQMIGNoB6gHIYaaHR0cHM6
            Ly88ZG9tYWluZS1icGNvPi9jcmyia6RpMGcxCzAJBgNVBAYTAkZSMSowKAYDVQQK
            DCFCYXNlIGRlcyBDZXJ0aWZpY2F0cyBPcMODwqlyYXRldXIxGTAXBgNVBAsMEFBv
            bGljeSBBdXRob3JpdHkxETAPBgNVBAMMCEJQQ08gUEExMBgGCCsGAQUFBwEaBAww
            CqAIFgZPUEMwMDAwCgYIKoZIzj0EAwIDRwAwRAIgNBAcIP/Gwx1rXvI2/PiflboV
            YVc3KWvfczSpXEMF61oCIG64G0cYxoO00MBdY+vg6umsNtA6eT0q5G6wW7dNjOTv
            -----END CERTIFICATE-----
        csr:
          type: string
          maxLength: 2048
          description: Contents of the CSR file used to create this certificate. Format of the contents is PEM.
          example: |
            -----BEGIN CERTIFICATE REQUEST-----
            MIIBEjCBuQIBADBXMRYwFAYDVQQDDA1TSEFLRU4gT1BDMDAwMQswCQYDVQQGEwJG
            UjEVMBMGA1UECgwMT3DDg8KpcmF0ZXVyMRkwFwYDVQQLDBBTZXJ2aWNlIFByb3Zp
            ZGVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2qw/qQeNfCytgqjIETfjmVEw
            7R7PrKZFaHLhaOxJabV1BN/AGp0Shm5f/pOZ19S9GVT0ULplSrl9+QrrpKLwjKAA
            MAoGCCqGSM49BAMCA0gAMEUCIADk95rHd2LAI6vCuz8OjqlA9FJAWC1j/QcK8HSb
            mMWkAiEAsVc1L/LvTKlEI98lsfDmCtKsJuQ4iBBuZ5Hzp0T1Xr8=
            -----END CERTIFICATE REQUEST-----
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            User who requested the certificate. Format shall be `<first name> <last name> <<email address>>`.
            May be set to `SYSTEM` if the certificate has been automatically created by the platform via the
            automated renewal logic.
            May otherwise be set to `API` if the request has been received via an API call.
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: |
            Last Update Date.
            Initially set to the same value as `created_at`.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            User who updated the certificate data. Format shall be `<first name> <last name> <<email address>>`.
            May be set to `API` if the request has been received via an API call.
            Initially set to the same value as `created_by`.
          example: John Doe <john.doe@spa.domain>
        revoked_at:
          type: string
          description: |
            Certificate revocation date. Only set if the certificate has been revoked, i.e if `status` is set to
            'REVOKED'.
          format: date-time
          example: '2022-08-17T10:12:25Z'
        revoked_by:
          type: string
          maxLength: 254
          description: |
            User who revoked the certificate. Format shall be `<first name> <last name> <<email address>>`.
            May be set to `API` if the request has been received via an API call, or to `CA` if the certificate has
            been revoked by the Certificate Authority.
          example: John Doe <john.doe@spa.domain>
        revoked_reason:
          type: string
          description: |
            Reason associated with the certificate revocation as defined in RFC 5280.
            Set only if the certificate has been revoked, i.e if `status` is set to `REVOKED`.
          enum:
            - unspecified
            - keyCompromise
            - affiliationChanged
            - superseded
            - cessationOfOperation
            - certificateHold
            - privilegeWithdrawn
          default: unspecified
          example: keyCompromise
        revoked_comments:
          type: string
          maxLength: 1024
          description: |
            Additional comments on the reason associated with the certificate revocation.
            Set only if the certificate has been revoked, i.e if `status` is set to `REVOKED`.
          example: Clé privée compromise
        issuer_dn:
          type: string
          description: |
            Distinguished Name of the certificate issuer.
          example: CN=BPCO CA1 - SHAKEN Intermediate,O=Base des Certificats Opérateurs,OU=Certificate Authority,C=FR
    CertificateId:
      description: ID of the certificate. Must be unique.
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: d240dd9e-a077-42f5-92e3-a3d3f10e002e
    CertificateStatus:
      type: string
      description: Certificate status.
      enum:
        - PENDING
        - ACTIVE
        - REVOKED
        - EXPIRED
        - INVALIDATION
        - INVALID
      example: ACTIVE
    CertificateSummaryView:
      type: object
      description: |
        Certificate data model (summary view). This model will be used for both active and archived certificates.
      required:
        - id
        - provider_id
        - type
        - name
        - valid_from
        - valid_to
        - test_certificate
        - status
        - archived
        - renewal_auto
        - renewed_by
        - issuer_dn
      properties:
        id:
          $ref: '#/components/schemas/CertificateId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the certificate.
            - $ref: '#/components/schemas/ProviderId'
        type:
          $ref: '#/components/schemas/CertificateType'
        opts:
          type: string
          description: |
            APNF Code of the technical signing service provider (OPTS). Mandatory when certificate `type` is `INDIRECT`,
            `null` otherwise.
          pattern: ^([0-9A-Z]{6})$
          example: SPB000
        name:
          type: string
          maxLength: 64
          description: |
            Certificate name provided by the origin service provider. Used to construct certificate Common Name.
          example: Main Certificate
        valid_from:
          type: string
          description: Certificate validity start date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        valid_to:
          type: string
          description: Certificate expiration date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
        test_certificate:
          type: boolean
          description: Is this a test certificate?
          example: false
        url:
          type: string
          maxLength: 2048
          description: URL of the certificate in the certificate public repository
          example: https://api.man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
        status:
          $ref: '#/components/schemas/CertificateStatus'
        archived:
          type: boolean
          description: Has the certificate been archived?
          example: false
        renewal_auto:
          type: boolean
          description: |
            Automated renewal option. If enabled, the application will create a new certificate using the same CSR and
            options provided for this certificate.
          example: true
        renewed_by:
          allOf:
            - description: ID of the new certificate that replaces this certificate.
            - $ref: '#/components/schemas/UUID'
        sn:
          type: string
          description: Certificate serial number
          pattern: ^([0-9A-Fa-f]{16,40})$
          example: 57ABB34BCA510043BDE438460F13B27E6A82C004
    CertificateType:
      type: string
      description: |
        Certificate type. A direct certificate is expected to be used directly by the service provider,
        while an indirect certificate is requested by the service provider for a technical signing service provider (OPTS).
      enum:
        - DIRECT
        - INDIRECT
      example: DIRECT
    CreationAuthor:
      allOf:
        - description: ID for the user who created the ticket or event
        - $ref: '#/components/schemas/UUID'
    CredentialId:
      description: ID of the API credential. Must be unique.
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: 9152f121-f66f-421c-87ce-78b218e250d4
    Date:
      type: string
      description: Date in ISO-8601 format
      format: date-time
      example: '2022-01-17T10:12:25Z'
    Delegatee:
      type: object
      description: Data model of delegatee summary view.
      required:
        - delegatee_id
        - client_internal_id
        - status
        - delegation_cnt
        - created_at
        - created_by
      properties:
        delegatee_id:
          $ref: '#/components/schemas/DelegateeId'
        client_internal_id:
          $ref: '#/components/schemas/DelegateeInternalClientId'
        description:
          $ref: '#/components/schemas/DelegateeDescription'
        status:
          $ref: '#/components/schemas/DelegateeStatus'
        delegation_cnt:
          type: integer
          description: Number of active display delegations created with this delegatee
          example: 0
        created_at:
          type: string
          description: Delegatee creation date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: Date the delegatee has been last updated.
          format: date-time
          example: '2025-02-01T11:00:00Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            Origin of the last update request. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
        revoked_at:
          type: string
          description: Revocation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        revoked_by:
          type: string
          maxLength: 254
          description: |
            Origin of the revocation action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
            - `SYSTEM` if the action is performed by the platform
          example: John Doe <john.doe@spa.domain>
    DelegateeCreationRequest:
      type: object
      description: Delegatee creation request data model
      required:
        - client_internal_id
      properties:
        client_internal_id:
          $ref: '#/components/schemas/DelegateeInternalClientId'
        description:
          $ref: '#/components/schemas/DelegateeDescription'
    DelegateeCreationResponse:
      type: object
      description: Data model of successful delegatee creation response.
      required:
        - delegatee_id
        - client_internal_id
        - status
        - delegation_cnt
        - created_at
        - created_by
      properties:
        delegatee_id:
          allOf:
            - description: Public delegatee ID to be provided to OSP client.
            - $ref: '#/components/schemas/UUID'
        client_internal_id:
          $ref: '#/components/schemas/DelegateeInternalClientId'
        description:
          $ref: '#/components/schemas/DelegateeDescription'
        status:
          $ref: '#/components/schemas/DelegateeStatus'
        delegation_cnt:
          type: integer
          description: Number of active display delegations created with this delegatee
          example: 0
        created_at:
          type: string
          description: Delegatee creation date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
    DelegateeDescription:
      type: string
      maxLength: 2048
      description: Delegatee optional description
      example: Lorem ipsum...
    DelegateeId:
      allOf:
        - description: Delegatee unique ID to be provided by the OSP to its client for creating display delegations.
        - $ref: '#/components/schemas/UUID'
    DelegateeInternalClientId:
      type: string
      maxLength: 128
      description: |
        Internal ID of OSP client.
        This property shall be used by provider to properly identify the client for which the delegatee is created.
        The value shall be unique across all delegatees created by the service provider.
      example: CLIENT-SI054
    DelegateeStatus:
      type: string
      description: Delegatee status
      enum:
        - ACTIVE
        - REVOKED
      example: ACTIVE
    DelegateeUpdateRequest:
      type: object
      description: |
        Delegatee update request data model.
        At least one propery shall be specified.
      properties:
        client_internal_id:
          $ref: '#/components/schemas/DelegateeInternalClientId'
        description:
          allOf:
            - description: |
                Description for the delegatee. Can be specified empty to remove the description currently assigned to the delegatee.
            - $ref: '#/components/schemas/DelegateeDescription'
    DelegateeUpdateResponse:
      type: object
      description: Data model of successful delegatee update response.
      required:
        - delegatee_id
        - client_internal_id
        - status
        - delegation_cnt
        - created_at
        - created_by
      properties:
        delegatee_id:
          $ref: '#/components/schemas/DelegateeId'
        client_internal_id:
          $ref: '#/components/schemas/DelegateeInternalClientId'
        description:
          $ref: '#/components/schemas/DelegateeDescription'
        status:
          $ref: '#/components/schemas/DelegateeStatus'
        delegation_cnt:
          type: integer
          description: Number of active display delegations created with this delegatee
          example: 0
        created_at:
          type: string
          description: Delegatee creation date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: Date the call has been performed.
          format: date-time
          example: '2025-02-01T11:00:00Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            Origin of the update request. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
    DelegationTicket:
      allOf:
        - oneOf:
            - $ref: '#/components/schemas/DelegationTicketForCreation'
        - type: object
          required:
            - id
            - provider_author_apnf_code
            - creation_date
            - creation_author
            - modification_date
            - modification_author
            - typology_criticality
            - issue_type
            - status
            - reference_id
          properties:
            id:
              $ref: '#/components/schemas/UUID'
            typology_label:
              type: string
              description: the label for the typology of the ticket
              example: Procédure de délégation d'affichage bloquée
            provider_author_apnf_code:
              $ref: '#/components/schemas/ProviderApnfCode'
            resolution:
              $ref: '#/components/schemas/TicketResolution'
            creation_date:
              $ref: '#/components/schemas/Date'
            creation_author:
              $ref: '#/components/schemas/CreationAuthor'
            modification_date:
              type: string
              description: date of the last modification
              format: date-time
              example: '2022-01-17T10:12:25Z'
            modification_author:
              allOf:
                - description: user who made the last modification
                - $ref: '#/components/schemas/UUID'
            typology_criticality:
              $ref: '#/components/schemas/TicketCriticality'
            issue_type:
              $ref: '#/components/schemas/DelegationTicketIssueType'
            status:
              $ref: '#/components/schemas/TicketStatus'
            reference_id:
              type: integer
              description: integer used to reference the ticket
              example: 1
            automatically_updated:
              type: boolean
              description: indicates if the last update was done by an automatic process
              example: false
    DelegationTicketForCreation:
      type: object
      required:
        - typology_code
        - provider_author_role
        - tns
        - description
        - next_action_required_by
        - ope
        - osp
      properties:
        typology_code:
          $ref: '#/components/schemas/DelegationTicketTypologyCode'
        provider_author_role:
          type: string
          description: Role of the provider creating the ticket
          enum:
            - OSP
            - OPE
          example: OSP
        tns:
          type: array
          description: List of single numbers or ranges of numbers.
          items:
            oneOf:
              - $ref: '#/components/schemas/Tn'
              - $ref: '#/components/schemas/TnRange'
          minItems: 1
          example:
            - '33123456789'
            - 262263123000-262263123100
        delegatee_id:
          $ref: '#/components/schemas/DelegateeId'
        description:
          type: string
          description: Description of the ticket
          example: This is not the first time
          maxLength: 500
        next_action_required_by:
          $ref: '#/components/schemas/ProviderApnfCode'
        estimated_issue_date:
          type: string
          description: Estimated date of issue noticing (if different from opening date). Date shall be in ISO-8601 format
          format: date-time
          example: '2022-01-17T10:12:25Z'
        author_ticket_internal_id:
          $ref: '#/components/schemas/TicketAuthorInternalId'
        ope:
          $ref: '#/components/schemas/ProviderApnfCode'
        osp:
          $ref: '#/components/schemas/ProviderApnfCode'
    DelegationTicketForList:
      type: object
      required:
        - id
        - issue_type
        - status
        - reference_id
        - delegatee_id
        - typology_code
        - typology_criticality
        - typology_label
        - next_action_required_by
        - provider_author_role
        - provider_author_apnf_code
        - modification_author_apnf_code
        - creation_date
        - modification_date
      properties:
        id:
          $ref: '#/components/schemas/UUID'
        issue_type:
          $ref: '#/components/schemas/DelegationTicketIssueType'
        status:
          $ref: '#/components/schemas/TicketStatus'
        reference_id:
          type: integer
          description: integer used to reference the ticket
          example: 1
        delegatee_id:
          $ref: '#/components/schemas/DelegateeId'
        author_ticket_internal_id:
          $ref: '#/components/schemas/TicketAuthorInternalId'
        typology_code:
          $ref: '#/components/schemas/DelegationTicketTypologyCode'
        typology_criticality:
          allOf:
            - description: Criticality of ticket
            - $ref: '#/components/schemas/TicketCriticality'
        typology_label:
          $ref: '#/components/schemas/TicketTypologyLabel'
        next_action_required_by:
          allOf:
            - description: Provider assigned to ticket
            - $ref: '#/components/schemas/ProviderApnfCode'
        provider_author_apnf_code:
          allOf:
            - description: APNF code of author provider
            - $ref: '#/components/schemas/ProviderApnfCode'
        modification_author_apnf_code:
          allOf:
            - description: APNF code of modification user
            - $ref: '#/components/schemas/ProviderApnfCode'
        provider_author_role:
          type: string
          description: Role of the provider creating the ticket
          enum:
            - OSP
            - OPE
          example: OSP
        creation_date:
          $ref: '#/components/schemas/Date'
        modification_date:
          allOf:
            - type: string
            - description: Last modification date
            - $ref: '#/components/schemas/Date'
    DelegationTicketForPatch:
      type: object
      properties:
        tns:
          description: |
            Telephone numbers for which a display delegation shall be created.

            This property is an array of elements, where each element is either a single telephone number
            or a range of consecutive telephone numbers.
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/Tn'
              - $ref: '#/components/schemas/TnRange'
          example:
            - '33123456789'
            - 262263123000-262263123100
        delegatee_id:
          $ref: '#/components/schemas/DelegateeId'
        description:
          type: string
          description: Description of the ticket
          example: This is not the first time
          maxLength: 500
        next_action_required_by:
          $ref: '#/components/schemas/ProviderApnfCode'
        estimated_issue_date:
          type: string
          description: Estimated date of issue noticing (if different from opening date). Date shall be in ISO-8601 format
          format: date-time
        author_ticket_internal_id:
          $ref: '#/components/schemas/TicketAuthorInternalId'
    DelegationTicketIssueType:
      type: string
      description: 'The type of the issue: Incident'
      enum:
        - INCIDENT
      example: INCIDENT
    DelegationTicketTypologyCode:
      type: string
      description: The type of the ticket
      example: D1
    DisplayDelegation:
      type: object
      description: Data model of a display delegation.
      required:
        - tn_start
        - tn_end
        - delegation_request_id
        - status
        - expiration_date
        - delegatee_id
        - created_at
      properties:
        id:
          allOf:
            - description: BND internal ID.
            - $ref: '#/components/schemas/UUID'
        tn_start:
          allOf:
            - description: |
                Telephone number.
                If `tn_end` is provided, provides the first number of the range defined with the number specified as `tn_end` property.
            - $ref: '#/components/schemas/Tn'
        tn_end:
          allOf:
            - description: |
                Telephone number.
                When provided, provides the last number of the range defined with the number specified as `tn_start` property.
                The property may be set to the same value than `tn_start`, meaning that this record is for one single telephone number.
            - $ref: '#/components/schemas/Tn'
        delegation_request_id:
          type: string
          format: UUID
          maxLength: 64
          description: |
            ID of the display delegation request used to create this record
          example: 743d9d17-85dd-4c2a-af9a-e89a72ce4089
        status:
          $ref: '#/components/schemas/DisplayDelegationStatus'
        expiration_date:
          type: string
          description: Expiration date of the display delegation
          format: date-time
          example: '2022-01-17T10:12:25Z'
        role:
          type: string
          maxLength: 8
          description: |
            Role of the provider for this display delegation.
            Available only when this is a provider that collects the information.
          enum:
            - OPE
            - OSP
            - OPE/OSP
          example: OPE
        ope:
          allOf:
            - $ref: '#/components/schemas/ProviderApnfCode'
            - description: |
                ID of the OPE of the numbers and that created the display delegation.
                Available only when the request is triggered by a *MAN_ADMINISTRATOR* or *APNF* user.
            - example: null
        osp:
          allOf:
            - $ref: '#/components/schemas/ProviderApnfCode'
            - description: |
                ID of the OSP associated to the display delegation.
                Available only when the request is triggered by a *MAN_ADMINISTRATOR* or *APNF* user.
            - example: null
        delegatee_id:
          allOf:
            - description: ID of the delegatee used for the display delegation creation process.
            - $ref: '#/components/schemas/DelegateeId'
        osp_client_internal_id:
          allOf:
            - description: |
                Internal ID of the OSP client who benefit from the display delegation
                The value is collected from the `Delegatee` record identified with the `delegatee_id` identifier.
            - $ref: '#/components/schemas/DelegateeInternalClientId'
        ope_information:
          $ref: '#/components/schemas/DisplayDelegationOpeInformation'
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call

            Not available to the OSP user or OSP API client.
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: |
            Last update Date.
            Not available to the OSP user or OSP API client.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            Origin of the update action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call

            Not available to the OSP user or OSP API client.
          example: John Doe <john.doe@spa.domain>
        revocation_requested_at:
          type: string
          description: |
            Date the revocation has been requested by the OPE.
            Not available to the OSP user or OSP API client.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        revoked_at:
          type: string
          description: |
            Display delegation effective revocation date.
            This corresponds to the date the display delegation status has been switched to `REVOKED`.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        revocation_origin:
          type: string
          description: |
            Origin of the revocation action. May be set to :
            - `OPE` if the revocation has been triggered by the OPE.
            - `OSP` if the action has been triggered by the revocation of the associated delegatee from the OSP
            - `SYSTEM` if the action has been triggered by the platform during cleanup process
          enum:
            - OPE
            - OSP
            - SYSTEM
          example: OPE
        revoked_by:
          type: string
          maxLength: 254
          description: |
            When the revocation has been triggered by the OPE, provides the autor of the revocation. May be set to:
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call

            Available only to OPE user or OPE API client.
            Available when `revocation_origin` is set to `OPE`.
          example: John Doe <john.doe@spa.domain>
    DisplayDelegationCreationRequest:
      type: object
      description: Display delegation creation request data model
      required:
        - tns
        - delegatee_id
        - expiration_date
      properties:
        tns:
          description: |
            Telephone numbers for which a display delegation shall be created.

            This property is an array of elements, where each element is either a single telephone number
            or a range of consecutive telephone numbers.

            The maximum array size is 100 by default.
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/Tn'
              - $ref: '#/components/schemas/TnRange'
          example:
            - '33123456789'
            - 262263123000-262263123100
        delegatee_id:
          allOf:
            - description: |
                Delegatee ID provided by the OSP client to the OPE client for creating the display delegation.
                This information will be used to associate the right OSP and its client
                (via the delegatee client_internal_id information) to the display delegation
            - $ref: '#/components/schemas/DelegateeId'
        expiration_date:
          type: string
          description: |
            Display delegation expiration date.

            There is no maximal value defined for the expiration date.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        ope_information:
          allOf:
            - description: |
                Optional information provided by the OPE to associate to the display delegation(s) to be created.
            - $ref: '#/components/schemas/DisplayDelegationOpeInformation'
    DisplayDelegationCreationResponse:
      type: array
      description: |
        Data model of successful delegatee creation response.
        List of display delegation that have been created.
      items:
        oneOf:
          - $ref: '#/components/schemas/DisplayDelegationCreationResponseEntry'
    DisplayDelegationCreationResponseEntry:
      type: object
      description: Data model of newly created display delegations.
      required:
        - delegation_id
        - tn_start
        - delegation_request_id
        - status
        - expiration_date
        - delegatee_id
        - created_at
        - created_by
      properties:
        delegation_id:
          allOf:
            - description: Delegation internal ID.
            - $ref: '#/components/schemas/UUID'
        tn_start:
          allOf:
            - description: |
                Telephone number.
                If `tn_end` is provided, provides the first number of the range defined with the number specified as `tn_end` property.
            - $ref: '#/components/schemas/Tn'
        tn_end:
          allOf:
            - description: |
                Telephone number.
                When provided, returns the last number of the range defined with the number specified as `tn_start` property.
                The property may be set to the same value than `tn_start`, meaning that this record is for one single telephone number.
            - $ref: '#/components/schemas/Tn'
        delegation_request_id:
          type: string
          format: UUID
          maxLength: 64
          description: |
            ID of the display delegation request used to create this record
          example: 743d9d17-85dd-4c2a-af9a-e89a72ce4089
        status:
          $ref: '#/components/schemas/DisplayDelegationStatus'
        role:
          type: string
          maxLength: 8
          description: |
            Role of the provider for this display delegation.
            When creating a display delegation, the provider may only by `OPE` or `OPE/OSP` if the delegatee
            used to create the display delegation is also creted by that provider.
          enum:
            - OPE
            - OPE/OSP
          example: OPE
        expiration_date:
          type: string
          description: Expiration date of the display delegation
          format: date-time
          example: '2022-01-17T10:12:25Z'
        delegatee_id:
          allOf:
            - description: ID of the delegatee used for the display delegation creation process.
            - $ref: '#/components/schemas/DelegateeId'
        ope_information:
          $ref: '#/components/schemas/DisplayDelegationOpeInformation'
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
          example: John Doe <john.doe@spa.domain>
    DisplayDelegationOpeInformation:
      type: string
      maxLength: 1024
      description: |
        Optional information provided by the OPE associated to the display delegation.
        This information is not available to the OSP associated to the display delegation.
      example: Lorem ipsum...
    DisplayDelegationRevocationResponse:
      type: object
      description: Data model of display delegation update response.
      required:
        - tn_start
        - tn_end
        - delegatee_id
        - revocation_requested_at
      properties:
        tn_start:
          allOf:
            - description: |
                Telephone number. Provides the first number of the range defined with the number specified as `tn_end` property.
            - $ref: '#/components/schemas/Tn'
        tn_end:
          allOf:
            - description: |
                Telephone number. Provides the last number of the range defined with the number specified as `tn_start` property.
                The property may be set to the same value than `tn_start`, meaning that this record is for one single telephone number.
            - $ref: '#/components/schemas/Tn'
        delegatee_id:
          allOf:
            - description: ID of the delegatee used for the display delegation creation process.
            - $ref: '#/components/schemas/DelegateeId'
        revocation_requested_at:
          type: string
          description: |
            Date the revocation request has been received by the platform.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        revoked_at:
          type: string
          description: |
            Only included if the display delegation is already revoked.
            Delegation effective revocation date.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        revocation_origin:
          type: string
          description: |
            Only included if the display delegation is already revoked.
            Origin of the revocation action. May be set to :
            - `OPE` if the revocation has been triggered by the OPE.
            - `OSP` if the action has been triggered by the revocation of the associated delegatee from the OSP
            - `SYSTEM` if the action has been triggered by the platform during cleanup process
          enum:
            - OPE
            - OSP
            - SYSTEM
          example: OPE
        revoked_by:
          type: string
          maxLength: 254
          description: |
            Only included if the display delegation is already revoked.
            When the revocation has been triggered by the OPE, provides the autor of the revocation. May be set to:
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call

            Available only to OPE user or OPE API client.
            Available when `revocation_origin` is set to `OPE`.
          example: John Doe <john.doe@spa.domain>
    DisplayDelegationStatus:
      type: string
      description: Display delegation status
      enum:
        - ACTIVE
        - EXPIRED
        - REVOKED
      example: ACTIVE
    DisplayDelegationUpdateResponse:
      type: object
      description: Data model of display delegation update response.
      required:
        - tn_start
        - tn_end
        - delegatee_id
      properties:
        tn_start:
          allOf:
            - description: |
                Telephone number. Provides the first number of the range defined with the number specified as `tn_end` property.
            - $ref: '#/components/schemas/Tn'
        tn_end:
          allOf:
            - description: |
                Telephone number. Provides the last number of the range defined with the number specified as `tn_start` property.
                The property may be set to the same value than `tn_start`, meaning that this record is for one single telephone number.
            - $ref: '#/components/schemas/Tn'
        delegatee_id:
          allOf:
            - description: ID of the delegatee used for the display delegation creation process.
            - $ref: '#/components/schemas/DelegateeId'
        expiration_date:
          type: string
          description: |
            New expiration date of the display delegation.
            Specified only if the expiration date has been updated.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        ope_information:
          allOf:
            - description: |
                New expiration date of the display delegation.
                Specified only if this information has been updated.
            - $ref: '#/components/schemas/DisplayDelegationOpeInformation'
    EmailAddress:
      type: string
      maxLength: 254
      description: Email address
      example: john.doe@spa.domain
    History:
      description: |
        Data model for history / activity log records.
        A history / activity log describes an action performed on an object in the application.
      type: object
      required:
        - id
        - date
        - subject
        - action
        - message
        - object
      properties:
        id:
          $ref: '#/components/schemas/HistoryId'
        date:
          type: string
          description: Date of the action using ISO-8601 date format (UTC timezone)
          format: date-time
          example: '2025-09-12T14:22:47.195187Z'
        subject:
          $ref: '#/components/schemas/HistorySubject'
        action:
          description: Action performed on the object
          type: string
          example: PASSWORD_RESET
          enum:
            - CREATE
            - UPDATE
            - DELETE
            - UNDELETE
            - LOGIN
            - LOGOUT
            - PASSWORD_RESET
            - REGISTER
            - AUTHORIZE
            - RENEW
            - REVOKE
            - REVOKE_INIT
        message:
          type: string
          description: Message describing the action that has been performed
          example: A credential has logged in
        object:
          $ref: '#/components/schemas/HistoryObject'
    HistoryId:
      description: ID of the history record. Must be unique.
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: c8d2874c-4fb8-44c0-ab39-4143e53870a4
    HistoryObject:
      description: Object on which the action was performed
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
          description: Type of the object
          enum:
            - API_CREDENTIAL
            - BPCO_CERTIFICATES
            - BPCO_CRL
            - CERTIFICATE
            - DELEGATEE
            - DELEGATION
            - PROVIDER
            - USER
        id:
          allOf:
            - description: ID of the object
            - $ref: '#/components/schemas/UUID'
        groups:
          type: object
          properties:
            provider:
              allOf:
                - description: ID of the provider associated to the history record
                - $ref: '#/components/schemas/UUID'
    HistorySubject:
      description: Subject who performed the action
      type: object
      required:
        - type
        - name
      properties:
        type:
          type: string
          description: Type of the subject
          enum:
            - CREDENTIAL
            - UNKNOWN
            - USER
            - SYSTEM
        id:
          allOf:
            - description: ID of the subject
            - $ref: '#/components/schemas/UUID'
        name:
          type: string
          description: |
            Name of the subject that performed the action.
            For a user, corresponds to its first and last names with the email address.
        ip_address:
          type: string
          description: IP address of the subject at the origin of the action
          format: ipv4
          pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.){3}(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)$
          example: 127.0.0.1
    ISMInterconnectionType:
      description: |
        Interconnection type.
        FULL MAN Interconnection : the provider is ready to activate the MAN's STIR-SHAKEN
        PARTIAL MAN : the provider is not completely ready to activate the MAN's STIR-SHAKEN
        NOT MAN : the provider is not ready to activate the MAN's STIR-SHAKEN
      enum:
        - FULL MAN
        - PARTIAL MAN
        - NOT MAN
      example: FULL MAN
      type: string
    ISMSummaryView:
      description: |
        Interconnections data model. This model will be used for list view and details view.
      properties:
        creation_date:
          type: string
          description: Deadline for taking into account by operators status changes on interconnections not less than 7 days.
          format: date-time
          example: '2022-01-21T10:12:25Z'
        date_last_update_emitter:
          type: string
          description: Last update provider emitter. To be calculated when inserting or modifying an interconnection. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        date_last_update_receiver:
          type: string
          description: Last update provider receiver. To be calculated when inserting or modifying an interconnection. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        interconnection_description:
          type: string
          maxLength: 2048
          description: Description of the interconnection.
          example: mobile vers mobile
        id:
          allOf:
            - description: ID of the interconnection.
            - $ref: '#/components/schemas/UUID'
        provider_emitter_code:
          type: string
          description: |
            APNF Code of the technical provider emitter
          pattern: ^([0-9A-Z]{6})$
          example: SPB000
        provider_emitter_status:
          $ref: '#/components/schemas/ISMInterconnectionType'
        provider_receiver_code:
          type: string
          description: |
            APNF Code of the technical provider receiver.
          pattern: ^([0-9A-Z]{6})$
          example: IPDI01
        provider_receiver_status:
          $ref: '#/components/schemas/ISMInterconnectionType'
      required:
        - creation_date
        - id
        - date_last_update_emitter
        - date_last_update_receiver
        - interconnection_description
        - provider_emitter_code
        - provider_emitter_status
        - provider_receiver_code
        - provider_receiver_status
      type: object
    Language:
      type: string
      enum:
        - FRENCH
        - ENGLISH
      example: FRENCH
    LanguageForNotifications:
      type: string
      enum:
        - DEFAULT
        - FREENG
        - FRENCH
        - ENGLISH
      example: ENGLISH
    LanguageForNotificationsByDefault:
      type: string
      enum:
        - FREENG
        - FRENCH
        - ENGLISH
      example: FRENCH
    Meteo:
      allOf:
        - $ref: '#/components/schemas/MeteoForCreation'
        - type: object
          required:
            - ID
            - creation_author
            - reference_id
          properties:
            ID:
              $ref: '#/components/schemas/UUID'
            provider_author_apnf_code:
              type: string
              description: APNF code for the provider creating the ticket
              pattern: ^([0-9A-Z]{6})$
            creation_author:
              $ref: '#/components/schemas/MeteoCreationAuthor'
            reference_id:
              type: integer
              description: integer used to reference the meteo
              example: 1
    MeteoCreationAuthor:
      allOf:
        - description: id for the user who created the ticket or event
        - $ref: '#/components/schemas/UUID'
    MeteoCriticality:
      description: the impact fo the meteo event
      enum:
        - INFORMATION
        - NO_IMPACT
        - OVERALL_IMPACT
        - PARTIAL_IMPACT
      type: string
    MeteoForCreation:
      properties:
        criticality:
          $ref: '#/components/schemas/MeteoCriticality'
        disengagement_id:
          type: string
          pattern: ^([0-9A-Z]{6})-([0-9A-Z\-]{0,16})$
          description: the current disengagement_id for the provider. if the tag DISENGAGEMENT is selected, it is mandatory , else it is forbidden.
          example: APNF00-123456789-ABCDE
        end_date:
          type: string
          description: end date of the event. Date shall be in ISO-8601 format
          format: date-time
          example: '2022-01-17T10:12:25Z'
        long_description:
          type: string
          description: A short description of the event
          example: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... '
          maxLength: 5000
        short_description:
          type: string
          description: A short description of the event
          example: L'opérateur OPE1 est en débrayage
          maxLength: 120
        start_date:
          type: string
          description: start date of the event (if different from opening date). Date shall be in ISO-8601 format
          format: date-time
          example: '2022-01-17T10:12:25Z'
        tags:
          type: array
          items:
            type: string
            description: The elements of MAN involved in the event
            enum:
              - BPCO
              - BSM_SFTP_SERVICES
              - DELEGATION
              - DISENGAGEMENT
              - MAN_APPLICATION
      required:
        - criticality
        - long_description
        - short_description
        - start_date
      type: object
    MeteoPatch:
      properties:
        criticality:
          $ref: '#/components/schemas/MeteoCriticality'
        disengagement_id:
          type: string
          pattern: ^([0-9A-Z]{6})-([0-9A-Z\-]{0,16})$
          description: the current disengagement_id for the provider. if the tag DISENGAGEMENT is selected, it is mandatory , else it is forbidden.
          example: APNF00-123456789-ABCDE
        end_date:
          type: string
          description: end date of the event. Date shall be in ISO-8601 format
          format: date-time
          example: '2022-01-17T10:12:25Z'
        long_description:
          type: string
          description: A short description of the event
          maxLength: 5000
          example: 'L''opérateur OPE1 est en débrayage car il a rencontré un problème lors d''une opération de... '
        short_description:
          type: string
          description: A short description of the event
          maxLength: 120
          example: L'opérateur OPE1 est en débrayage
        start_date:
          type: string
          description: start date of the event (if different from opening date). Date shall be in ISO-8601 format
          format: date-time
          example: '2022-01-17T10:12:25Z'
        tags:
          type: array
          items:
            type: string
            description: The elements of MAN involved in the event
            enum:
              - BPCO
              - MAN_APPLICATION
              - BSM_SFTP_SERVICES
              - DISENGAGEMENT
              - DELEGATION
      type: object
    PaginationMetaData:
      type: object
      description: Information regarding paginated results
      properties:
        offset:
          type: integer
          description: Current offset
          default: 0
          example: 40
        limit:
          type: integer
          description: Number of resources per page
          minimum: 1
          default: 20
          maximum: 100
        links:
          type: object
          properties:
            next:
              type: string
              description: Path to retrieve the next page
              pattern: ^(\/([\w-.~]|%[0-9A-Za-z]{2})*)*(\?([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?((&|;)([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?)*)?(#([\w-.~]|%[0-9A-Za-z]{2})+)?$
              example: /resource?offset=60&limit=20
            first:
              type: string
              description: Path to retrieve the first page
              pattern: ^(\/([\w-.~]|%[0-9A-Za-z]{2})*)*(\?([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?((&|;)([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?)*)?(#([\w-.~]|%[0-9A-Za-z]{2})+)?$
              example: /resource?offset=0&limit=20
            prev:
              type: string
              description: Path to retrieve the previous page
              pattern: ^(\/([\w-.~]|%[0-9A-Za-z]{2})*)*(\?([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?((&|;)([\w-.~]|%[0-9A-Za-z]{2})+(=([\w-.~]|%[0-9A-Za-z]{2})+)?)*)?(#([\w-.~]|%[0-9A-Za-z]{2})+)?$
              example: /resource?offset=20&limit=20
    PendingIndirectCertificate:
      type: object
      description: |
        Indirect Certificate Request data model. This model is used when the origin service provider requests the
        creation of a certificate for a technical provider (OPTS)
      required:
        - id
        - provider_id
        - opts
        - type
        - name
        - valid_from
        - valid_to
        - test_certificate
        - status
        - renewal_auto
        - created_at
        - created_by
      properties:
        id:
          $ref: '#/components/schemas/CertificateId'
        provider_id:
          allOf:
            - description: ID of the service provider that requested the certificate.
            - $ref: '#/components/schemas/ProviderId'
        type:
          allOf:
            - enum:
                - INDIRECT
            - example: INDIRECT
            - $ref: '#/components/schemas/CertificateType'
        opts:
          type: string
          description: APNF Code of the technical signing service provider (OPTS).
          pattern: ^([0-9A-Z]{6})$
          example: SPB000
        name:
          type: string
          maxLength: 64
          description: Certificate name provided by the origin service provider
          example: Indirect Certificate
        description:
          type: string
          maxLength: 1024
          description: Additional information related to the certificate
          example: Description of the certificate.
        test_certificate:
          type: boolean
          description: Is this certificate a test?
          example: false
        valid_from:
          type: string
          description: Certificate validity start date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        valid_to:
          type: string
          description: Certificate expiration date. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
        renewal_auto:
          type: boolean
          description: |
            Automated renewal option. If enabled, the application will create a new certificate using the same CSR and
            options provided for this certificate.
          example: true
        renewal_after:
          type: integer
          description: |
            Number of days after certificate validity start date to wait
            for the automated certificate renewal process to be triggered.
            Set only if `renewal_auto` is set to `true`.
          example: 300
        status:
          type: string
          description: Certificate status. Will always be set to PENDING
          enum:
            - PENDING
          example: PENDING
          default: PENDING
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            User who requested the certificate. Format shall be `<first name> <last name> <<email address>>`.
            May be set to `SYSTEM` if the certificate has been automatically created by the platform via the
            automated renewal logic.
            May otherwise be set to `API` if the request has been received via an API call.
          example: John Doe <john.doe@spa.domain>
    Perimeter:
      type: string
      description: Credential perimeter.
      enum:
        - CALL_AUTHENTICATION
        - DISPLAY_DELEGATION
      example: CALL_AUTHENTICATION
    Provider:
      allOf:
        - type: object
          required:
            - id
            - status
          properties:
            id:
              $ref: '#/components/schemas/ProviderId'
            status:
              $ref: '#/components/schemas/ProviderStatus'
        - $ref: '#/components/schemas/ProviderCreationRequest'
        - description: Provider data model
        - type: object
          required:
            - last_verification
            - deleted
            - created_at
            - created_by
            - updated_at
            - updated_by
          properties:
            legal_administrator:
              type: string
              description: |
                Represent the user which is the legal agent of the provider
              example: John Doe <john.doe@spa.domain>
            opts_allowed:
              type: array
              description: |
                List of providers OPTS that can be used to create an indirect certificate.

                This list is generated by the platform based on `opts_contracts`.
              items:
                $ref: '#/components/schemas/ProviderCode'
              default: []
              example:
                - SPB000
                - SPC000
                - SPD000
            deleted:
              type: boolean
              description: |
                Deleted status.
                The user of the deleted provider do not have access anymore to the application. this provider will be
                effectively erased after 3 months.
                During that period, it is possible to "undelete" a provider.
              default: false
              example: false
            created_at:
              type: string
              description: Creation Date
              format: date-time
              example: '2022-01-17T10:12:25Z'
            created_by:
              type: string
              maxLength: 254
              description: |
                User who created the provider. Format shall be `<first name> <last name> <<email address>>`.
                May otherwise be set to `API` if the action has been triggered by an API call or `SYSTEM` if the action
                is performed by the platform.
              example: John Doe <john.doe@spa.domain>
            updated_at:
              type: string
              description: |
                Last Update Date.
                Initially set to the same value as `created_at`.
              format: date-time
              example: '2022-05-17T10:12:25Z'
            updated_by:
              type: string
              maxLength: 254
              description: |
                User who updated the provider data. Format shall be `<first name> <last name> <<email address>>`.
                May otherwise be set to `API` if the action has been triggered by an API call or `SYSTEM` if the action
                is performed by the platform.
                Initially set to the same value as `created_by`.
              example: John Doe <john.doe@spa.domain>
            deleted_at:
              type: string
              description: Deletion date
              format: date-time
              nullable: true
              example: '2022-05-17T10:12:25Z'
            deleted_by:
              type: string
              maxLength: 254
              description: |
                User who deleted the provider. Format shall be `<first name> <last name> <<email address>>`.
                May otherwise be set to `API` if the action has been triggered by an API call or `SYSTEM` if the action
                is performed by the platform.
              nullable: true
              example: John Doe <john.doe@spa.domain>
            bypass_token:
              $ref: '#/components/schemas/BypassTokenId'
    ProviderApnfCode:
      type: string
      description: APNF code of the provider affected
      pattern: ^([0-9A-Z]{6})$
      example: OPE100
    ProviderCode:
      type: string
      description: Service Provider Code. Each service provider in France is assigned a unique code by the APNF.
      pattern: ^([0-9A-Z]{6})$
      example: SPA000
    ProviderCreationRequest:
      type: object
      description: Provider creation request data model
      required:
        - name
        - code
        - global_notification_list
        - legal_notification_list
        - certificate_notification_list
        - address
        - signing_provider
        - languages
        - authentication_mode
        - ticket_notification_active
        - default_notification_language
        - global_notification_list_language
        - certificate_notification_list_language
        - deposit_notification_list_language
        - legal_notification_list_language
        - ticketing_notification_list_language
        - delegation_notification_list_language
        - delegation_ticketing_notification_list_language
      properties:
        name:
          type: string
          maxLength: 64
          description: Provider name
          example: Opérateur A
        code:
          $ref: '#/components/schemas/ProviderCode'
        address:
          type: string
          maxLength: 255
          description: Provider HQ address
          example: 30, rue de Paris 75018 Paris
        technical_number:
          type: string
          maxLength: 15
          description: |
            Phone number injected by the provider in SIP INVITE messages when the phone number specified in the `orig` field is not valid format for the STIR Shaken protocol.
            Number format shall comply with E.164 protocol.
          example: '+33123456789'
        signatory:
          type: boolean
          description: |
            Flag to indicate if the provider is expected to sign phone calls and.
            Only signatory providers shall be allowed to have certificates delivered.
          default: true
        opts:
          type: boolean
          description: |
            Flag to indicate if the provider declares itself as a technical signatory provider (OPTS),
            e.g. a provider that can sign phone calls on behalf of other signatory providers.

            This property can be set to `TRUE` only if `signatory` is also set to `TRUE`.
          default: false
          example: true
        opts_contracts:
          type: array
          description: |
            List of providers allowed to choose this provider as OPTS.
          items:
            $ref: '#/components/schemas/ProviderCode'
          default: []
          example:
            - SPB000
            - SPC000
            - SPD000
        global_notification_list:
          description: |
            List of email addresses for the provider 'global' notification list.
            Will receive any general information published by the platform.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        certificate_notification_list:
          description: |
            List of email addresses for the provider 'certificate' notification list.
            Will receive any information published by the platform related to certificates creation and revocation.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        delegation_near_expiration_notification_active:
          description: |
            If the function is disabled, notifications from the delegation management tools are not sent when delegations are close to expiration.
            Unless there is a major incident on the MAN platform which requires imperative consideration of the notification.
          type: boolean
          default: true
        delegation_notification_list:
          description: |
            List of email addresses for the provider 'delegation' notification list.
            Will receive any information published by the platform related to obsolete or near expiration delegations.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        delegation_ticket_notification_active:
          description: |
            If the function is disabled, notifications from the delegation ticket management tools are not sent
            Unless there is a major incident on the MAN platform which requires imperative consideration of the
            notification.
          type: boolean
          default: false
        delegation_ticketing_notification_list:
          description: |
            List of email addresses for the provider 'delegation ticketing' notification list.
            Will receive any information published by the platform related to delegation ticket evolution.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        deposit_notification_list:
          description: |
            List of email addresses for the provider 'deposit' notification list.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        legal_notification_list:
          description: |
            List of email addresses for the provider 'legal' notification list.
            Will receive any information published by the platform related to provider authorization.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        ticketing_notification_list:
          description: |
            List of email addresses for the provider 'ticketing' notification list.
            Will receive any information published by the platform related to ticket evolution.
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          default: []
          example:
            - john.doe@spa.domain
            - jane.doe@spa.domain
        ticket_notification_active:
          description: |
            If the function is disabled, notifications from the ticket management tools are not sent
            Unless there is a major incident on the MAN platform which requires imperative consideration of the
            notification.
          type: boolean
          default: true
        sftp_allowed_keys:
          type: array
          description: |
            SSH public keys allowed to access the platform SFTP service created for the provider

            If no values are specified, no connection to the SFTP service will be possible.
          items:
            type: string
            maxLength: 1024
            description: SSH public key contents
            example: ssh-rsa AAAAB3NzaC...p5CSsDJ SI@host-4527
        sftp_allowed_ips:
          type: array
          description: |
            List of IPv4 addresses to be allowed to connect to the SFTP BSM service.

            If no values are specified, connections to the SFTP service will be possible from any IP address.
          items:
            type: string
            description: IPv4 address
            format: ipv4
            pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.){3}(25[0-5]|(2[0-4]|1\d|[1-9]|)\d)$
            example: 127.0.0.1
        languages:
          type: array
          description: |
            List of languages to be proposed to the provider users for the platform UI.
          items:
            $ref: '#/components/schemas/Language'
          default:
            - FRENCH
          example:
            - FRENCH
            - ENGLISH
        authentication_mode:
          type: string
          description: Mode to be used to authenticate provider user accounts.
          enum:
            - SSO
            - MFA
          default: MFA
          example: SSO
        sso_settings:
          $ref: '#/components/schemas/ProviderSSOSettings'
        default_notification_language:
          $ref: '#/components/schemas/LanguageForNotificationsByDefault'
        global_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        certificate_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        deposit_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        legal_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        ticketing_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        delegation_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
        delegation_ticketing_notification_list_language:
          $ref: '#/components/schemas/LanguageForNotifications'
    ProviderId:
      description: ID of the provider. Must be unique.
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: cc4519cb-b2b6-45ad-904c-7698fdf72ba2
    ProviderOIDCSettings:
      type: object
      description: Configuration of an OpenID Connect identity provider
      properties:
        authorizationUrl:
          type: string
          example: https://samples.auth0.com/authorize
        tokenUrl:
          type: string
          example: https://samples.auth0.com/oauth/token
        logoutUrl:
          type: string
          description: |
            End session endpoint to use to logout user from external IDP. This is optional.
        userInfoUrl:
          type: string
          description: |
            The User Info Url. This is optional.
          example: https://samples.auth0.com/userinfo
        issuer:
          type: string
          description: |
            The issuer identifier for the issuer of the response. If not provided, no validation will be performed.
          example: https://samples.auth0.com/
        validateSignature:
          type: boolean
          description: |
            Enable/disable signature validation of external IDP signatures.
          example: true
        useJwksUrl:
          type: boolean
          description: |
            If true, identity provider public keys will be downloaded from given JWKS URL.
          example: true
        jwksUrl:
          type: string
          description: |
            URL where identity provider keys in JWK format are stored.
          example: https://samples.auth0.com/.well-known/jwks.json
        clientAuthMethod:
          type: string
          description: |
            The client authentication method (cfr. https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication).
            In case of JWT signed with private key, the realm private key is used.
          enum:
            - clientAuth_post
            - clientAuth_basic
            - clientAuth_secret_jwt
            - clientAuth_privatekey_jwt
          example: clientAuth_post
        clientId:
          type: string
          description: |
            The client identifier registered with the identity provider.
          example: kbyuFDidLLm280LIwVFiazOqjO3ty8KH
        clientSecret:
          type: string
          description: |
            The client secret registered with the identity provider.
          example: 60Op4HFM0I8ajz0WdiStAbziZ-VFQttXuxixHHs2R7r7-CW8GR79l-mmLqMhc-Sa
    ProviderRole:
      type: string
      description: |
        role of the provider
        for Voice communications, may be SIGNATORY_OPTS, SIGNATORY_STI_AS, OPTS, TRANSIT, ONLY_VERIFICATION (OPTV) , ONLY TERMINATION, VERIFICATION_TERMINATION
        for Text communications, may be EMITTER or TERMINATION_VOICE
      enum:
        - SIGNATORY_OPTS
        - SIGNATORY_STI_AS
        - OPTS
        - TRANSIT
        - ONLY_VERIFICATION
        - ONLY TERMINATION
        - VERIFICATION_TERMINATION
        - EMITTER
        - TERMINATION_VOICE
      example: SIGNATORY_OPTS
    ProviderSSOSettings:
      allOf:
        - oneOf:
            - $ref: '#/components/schemas/ProviderOIDCSettings'
        - type: object
          description: |
            Single Sign-On configuration.
            To be used only when `authentication_mode` is set to `SSO`.
          default: null
          properties:
            type:
              type: string
              enum:
                - OIDC
    ProviderStatus:
      type: string
      description: Provider status
      enum:
        - REGISTRATION
        - ENABLED
        - DISABLED
      example: ENABLED
    ProviderVerificationContact:
      description: the contact who will be checked during the meeting
      properties:
        email:
          allOf:
            - $ref: '#/components/schemas/EmailAddress'
            - description: the mail address of the contact
        first_name:
          description: the first name of the contact
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
            - description: the spoken language of the contact
        last_name:
          description: the last name of the contact
          type: string
        phone_number:
          description: the phone number of the contact
          maxLength: 20
          type: string
      required:
        - email
        - first_name
        - language
        - last_name
        - phone_number
      type: object
    ProviderVerificationSecret:
      description: The shared secret as proof of verification
      pattern: ^([0-9]{6})$
      type: string
    RFC7231.HTTP-date:
      type: string
      description: Date format as defined in RFC7231, section 7.1.1.1.
      pattern: ^((Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT)$
      example: Mon, 17 Jan 2022 10:12:25 GMT
    RenewedCertificate:
      allOf:
        - $ref: '#/components/schemas/Certificate'
      type: object
      required:
        - id
        - provider_id
        - opts
        - type
        - name
        - valid_from
        - valid_to
        - test_certificate
        - url
        - sn
        - contents
        - status
        - renewal_auto
        - created_at
        - created_by
        - issuer_dn
    Source:
      type: string
      description: The source who reported the issue
      enum:
        - PROVIDER
        - CLIENT
      example: PROVIDER
    Ticket:
      allOf:
        - $ref: '#/components/schemas/TicketForCreation'
        - properties:
            id:
              $ref: '#/components/schemas/UUID'
            typology_label:
              type: string
              description: the label for the typology of the ticket
              example: Numéro appelant usurpé (suite à vérification)
            provider_author_apnf_code:
              $ref: '#/components/schemas/TicketProviderAuthorApnfCode'
            resolution:
              $ref: '#/components/schemas/TicketResolution'
            creation_date:
              $ref: '#/components/schemas/TicketCreationDate'
            creation_author:
              $ref: '#/components/schemas/TicketCreationAuthor'
            modification_date:
              type: string
              description: date of the last modification
              format: date-time
              example: '2022-01-17T10:12:25Z'
            modification_author:
              allOf:
                - description: user who made the last modification
                - $ref: '#/components/schemas/UUID'
            issue_type:
              $ref: '#/components/schemas/TicketIssueType'
            typology_criticality:
              $ref: '#/components/schemas/TicketCriticality'
            typology_category:
              $ref: '#/components/schemas/TicketCategory'
            status:
              $ref: '#/components/schemas/TicketStatus'
            reference_id:
              type: integer
              description: integer used to reference the ticket
              example: 1
          required:
            - id
            - provider_author_apnf_code
            - creation_date
            - creation_author
            - modification_date
            - modification_author
            - issue_type
            - typology_criticality
            - typology_category
            - status
            - reference_id
        - type: object
    TicketAuthorInternalId:
      type: string
      description: Ticket author's internal identifier
      example: My_Internal_ID123
    TicketCategory:
      type: string
      description: the category for the typology
      example: Constatation ou suspicion d'usurpation de numéro
    TicketComment:
      type: object
      properties:
        text:
          description: the text of the comment
          type: string
          example: this a comment
          maxLength: 500
        provider_author_apnf_code:
          $ref: '#/components/schemas/TicketProviderAuthorApnfCode'
        creation_date:
          type: string
          description: date of creation of the comment
          format: date-time
          example: '2022-01-17T10:12:25Z'
    TicketCommunicationType:
      type: string
      description: 'The type of communication: voice or text'
      enum:
        - VOICE
        - TEXT
      example: VOICE
    TicketCreationAuthor:
      allOf:
        - description: id for the user who created the ticket or event
        - $ref: '#/components/schemas/UUID'
    TicketCreationDate:
      type: string
      description: creation date of the ticket
      format: date-time
      example: '2022-01-17T10:12:25Z'
    TicketCriticality:
      type: integer
      description: the criticality level of the issue (as an integer from 1 to 3)
      enum:
        - 1
        - 2
        - 3
    TicketEgressProvider:
      type: string
      description: |
        Only for Voice issues
        Provider to whom the call is delivered (APNF code)
      pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketEmitter:
      type: string
      description: |
        Only for Message issues
        APNF code for the OPTV ( technical validation provider)
      pattern: ^([0-9A-Z]{6})$
    TicketForCreation:
      allOf:
        - $ref: '#/components/schemas/TicketVoice'
        - $ref: '#/components/schemas/TicketMessage'
        - type: object
          required:
            - typology_code
            - description
            - source
            - number_of_communications
            - provider_author_role
            - next_action_required_by
          properties:
            communication_type:
              $ref: '#/components/schemas/TicketCommunicationType'
            typology_code:
              $ref: '#/components/schemas/TicketTypologyCode'
            description:
              type: string
              description: The description of the ticket
              example: Ce n'est pas la première fois
              maxLength: 500
            source:
              $ref: '#/components/schemas/Source'
            number_of_communications:
              type: integer
              minimum: 1
              description: |
                For Voice issues :The number of calls affected by the issue
                For Text issues :The number of messages affected by the issue
              example: 1
            provider_author_role:
              $ref: '#/components/schemas/ProviderRole'
            next_action_required_by:
              $ref: '#/components/schemas/TicketNextActionRequiredBy'
            called_number:
              type: string
              description: called number (or alias)
              pattern: ^((\+|)[0-9]{0,13})|((\+[1-9]|0)\d{1,14})$
              example: '102030406'
            communication_timestamp:
              type: integer
              description: |
                for Voice issues, the timestamp of the call
                for Text issues, the timestamp of the message
              example: '1660742563701'
            is_reoccurring_issue:
              type: boolean
              description: is the issue reoccurring ?
              example: false
            is_related_to_single_called_customer:
              type: boolean
              description: |
                is the issue related to a single customer ?
              example: false
            estimated_issue_date:
              type: string
              description: Estimated date of issue noticing (if different from opening date). Date shall be in ISO-8601 format
              format: date-time
              example: '2022-01-17T10:12:25Z'
            author_ticket_internal_id:
              type: string
              maxLength: 50
              description: Identifiant interne de l'opérateur auteur
    TicketIngressProvider:
      type: string
      description: |
        Only for Voice issues
        Upstream provider who delivered the call (APNF code)
      pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketIssueType:
      type: string
      description: 'The type of the issue: Incident or Reporting'
      enum:
        - INCIDENT
        - REPORTING
      example: INCIDENT
    TicketMessage:
      type: object
      properties:
        emitter:
          $ref: '#/components/schemas/TicketEmitter'
        termination_message:
          $ref: '#/components/schemas/TicketTerminationProviderMessage'
        other_non_provider_actor:
          type: string
          maxLength: 50
          description: |
            Only for Message issues, mandatory
            Agregator
          example: Agregator
        message_type:
          type: string
          description: |
            Only for Message issues, mandatory
            the type of the message
          enum:
            - SMS
            - MMS
            - RCS
          example: SMS
        displayed_identifier:
          type: string
          maxLength: 20
          description: |
            Only for Message issues
            the displayed identifier
            can be alphanumeric
          example: '102030406'
        issuer_id:
          type: string
          maxLength: 50
          description: Identifiant émetteur (si différent de l’identifiant affiché)
    TicketModificationAuthorCode:
      type: string
      description: The APNF code of the last modification author
      pattern: ^([0-9A-Z]{6})$
      example: TERM00
    TicketModificationDate:
      type: string
      description: Last modification date
      format: date-time
      example: '2022-01-17T10:12:25Z'
    TicketNextActionRequiredBy:
      type: string
      description: next action is required by this provider (APNF code)
      pattern: ^([0-9A-Z]{6})$
      example: OPE200
    TicketOpts:
      type: string
      description: |
        Only for Voice issues
        APNF code for the OPTS ( technical signature provider)
      pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketOptv:
      type: string
      description: |
        Only for Voice issues
        APNF code for the OPTV ( technical validation provider)
      pattern: ^([0-9A-Z]{6})$
      example: OPTV00
    TicketPatch:
      properties:
        egress_provider:
          $ref: '#/components/schemas/TicketEgressProvider'
        emitter:
          $ref: '#/components/schemas/TicketEmitter'
        ingress_provider:
          $ref: '#/components/schemas/TicketIngressProvider'
        next_action_required_by:
          $ref: '#/components/schemas/TicketNextActionRequiredBy'
        opts:
          $ref: '#/components/schemas/TicketOpts'
        optv:
          $ref: '#/components/schemas/TicketOptv'
        signatory:
          $ref: '#/components/schemas/TicketSignatory'
        termination_message:
          $ref: '#/components/schemas/TicketTerminationProviderMessage'
        termination_provider:
          $ref: '#/components/schemas/TicketTerminationProvider'
        author_ticket_internal_id:
          $ref: '#/components/schemas/TicketAuthorInternalId'
      type: object
    TicketProviderAuthorApnfCode:
      type: string
      description: APNF code for the provider creating the ticket
      pattern: ^([0-9A-Z]{6})$
    TicketResolution:
      type: string
      description: the resolution code
      example: FIXED
      enum:
        - FIXED
        - JUSTIFIED
        - REJECTED
        - WRONGLY_OPENED
        - AUTOMATICALLY_CLOSED
    TicketSignatory:
      type: string
      description: |
        Only for Voice issues
        APNF code for the original signatory provider, certificate provider
      pattern: ^([0-9A-Z]{6})$
      example: OPE100
    TicketStatus:
      type: string
      description: Current status of the ticket
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
      example: OPEN
    TicketSummary:
      properties:
        communication_type:
          $ref: '#/components/schemas/TicketCommunicationType'
        creation_date:
          $ref: '#/components/schemas/TicketCreationDate'
        id:
          $ref: '#/components/schemas/UUID'
        issue_type:
          $ref: '#/components/schemas/TicketIssueType'
        next_action_required_by:
          $ref: '#/components/schemas/TicketNextActionRequiredBy'
        provider_author_apnf_code:
          $ref: '#/components/schemas/TicketProviderAuthorApnfCode'
        reference_id:
          type: integer
          description: integer used to reference the ticket
          example: 1
        status:
          $ref: '#/components/schemas/TicketStatus'
        typology_category:
          $ref: '#/components/schemas/TicketCategory'
        typology_code:
          $ref: '#/components/schemas/TicketTypologyCode'
        typology_criticality:
          $ref: '#/components/schemas/TicketCriticality'
        signatory:
          $ref: '#/components/schemas/TicketSignatory'
        emitter:
          $ref: '#/components/schemas/TicketEmitter'
        termination_voice:
          $ref: '#/components/schemas/TicketTerminationProvider'
        opts:
          $ref: '#/components/schemas/TicketOpts'
        optv:
          $ref: '#/components/schemas/TicketOptv'
        ingress:
          $ref: '#/components/schemas/TicketIngressProvider'
        termination_message:
          $ref: '#/components/schemas/TicketTerminationProviderMessage'
        author_ticket_internal_id:
          $ref: '#/components/schemas/TicketAuthorInternalId'
        modification_author_apnf_code:
          $ref: '#/components/schemas/TicketModificationAuthorCode'
        modification_date:
          $ref: '#/components/schemas/TicketModificationDate'
      required:
        - communication_type
        - creation_date
        - id
        - issue_type
        - next_action_required_by
        - provider_author_apnf_code
        - reference_id
        - status
        - typology_category
        - typology_code
        - typology_criticality
      type: object
    TicketTerminationProvider:
      type: string
      description: |
        Only for Voice issues
        Termination provider (APNF code)
      pattern: ^([0-9A-Z]{6})$
      example: TERM00
    TicketTerminationProviderMessage:
      type: string
      description: |
        Only for Message issues
        APNF code for the OPTV ( technical validation provider)
      pattern: ^([0-9A-Z]{6})$
      example: TERM00
    TicketTypologyCode:
      type: string
      description: The type of the ticket
      example: M1
    TicketTypologyLabel:
      type: string
      description: The label of the typology
      example: Numero appelant usurpe
    TicketTypologyListView:
      type: object
      required:
        - typology_code
        - typology_label
        - typology_category
        - issue_type
        - criticality
      properties:
        issue_type:
          $ref: '#/components/schemas/TicketIssueType'
        typology_category:
          $ref: '#/components/schemas/TicketCategory'
        typology_label:
          $ref: '#/components/schemas/TicketTypologyLabel'
        typology_code:
          $ref: '#/components/schemas/TicketTypologyCode'
        criticality:
          $ref: '#/components/schemas/TicketCriticality'
    TicketVoice:
      type: object
      properties:
        signatory:
          $ref: '#/components/schemas/TicketSignatory'
        opts:
          $ref: '#/components/schemas/TicketOpts'
        ingress_provider:
          $ref: '#/components/schemas/TicketIngressProvider'
        egress_provider:
          $ref: '#/components/schemas/TicketEgressProvider'
        termination_provider:
          $ref: '#/components/schemas/TicketTerminationProvider'
        optv:
          $ref: '#/components/schemas/TicketOptv'
        display_number:
          type: string
          description: |
            Only for Voice issues
            the displayed phone number
          pattern: ^((\+|)[0-9]{0,13})|((\+[1-9]|0)\d{1,14})$
          example: '102030406'
        display_number_type:
          type: string
          description: |
            Only for Voice issues, mandatory
            the type of the display number: landline, mobile or other
          enum:
            - LANDLINE
            - MOBILE
            - OTHER
          example: LANDLINE
        has_identity_header:
          type: boolean
          description: |
            Only for Voice issues, mandatory
            is the Identity header present ?
          example: true
        is_sti_vs_valid:
          type: boolean
          description: |
            Only for Voice issues
            does the call has a valid STI-VS
          example: true
        shaken_attestation_value:
          type: string
          description: |
            Only for Voice issues
            The shaken attestation value
          enum:
            - A
            - B
            - C
          example: A
        last_known_interconnection:
          type: string
          description: |
            Only for Voice issues
            last known interconnection (SIP, RTC, OTHER)
          enum:
            - SIP
            - RTC
            - OTHER
          example: SIP
        sip_reject_code:
          type: string
          maxLength: 20
          description: |
            Only for Voice issues
            SIP reject code
          example: ''
        sip_reject_sub_code:
          type: string
          maxLength: 120
          description: |
            Only for Voice issues
            SIP reject sub code
          example: ''
        is_emergency_call:
          type: boolean
          description: |
            Only for Voice issues
            Is the call an emergency call
          example: false
        calling_number:
          type: string
          description: |
            Only for Voice issues
            Calling number (if different of display number)
            (to be completed if known and different from display number)
          pattern: ^((\+|)[0-9]{0,13})|((\+[1-9]|0)\d{1,14})$
          example: '123456789'
        is_call_breakable:
          type: boolean
          description: |
            Only for Voice issues
            is the call breakable ?
          example: false
        is_call_broken:
          type: boolean
          description: |
            Only for Voice issues
            is the call broken ?
          example: false
    Tn:
      description: |
        Telephone number. The format is defined in the `Mode opératoire de la délégation d'affichage` document, but can be defined as following:

        `CC(C)ZABPQMCDUαβγ(δ)`, where at least the following constraints are defined:

        - `CC(C)` is the country code using 2 or 3 digits. The allowed values are: 33, 590, 594, 596, 262 and 508.
        - `Z` cannot be set to 6 or 7
        - `ZA` cannot be set to 89
      type: integer
      pattern: ^([1-9][0-9]{1,14})$
      example: 33123456789
    TnRange:
      description: |
        Telephone number range, represented by the starting and ending number, separated by a 'dash' character.

        Check the description of the `Tn` schema for the format that starting and ending numbers shall comply with.
      type: string
      pattern: ^([1-9][0-9]{1,14})-([1-9][0-9]{1,14})$
      example: 33123456789-33123456900
    Trace:
      description: |
        Traces data model.
      properties:
        author_provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                Provider responsible who made the trace.
                This field has the same value as `author_provider` if `author_provider_role` is
                `terminating`, `transit`, `optv_client` or `unknown`. Otherwise, it has the same
                value as `terminating_provider`.
        author_provider_role:
          allOf:
            - $ref: '#/components/schemas/TraceProviderRole'
            - description: Role of the provider who made the trace.
        attestation:
          allOf:
            - $ref: '#/components/schemas/TraceShakenAttestationLevel'
            - description: |
                Shaken attestation level.
                Mandatory if `identity_header` is `yes` and `author_provider_role` is different than
                `transit`.
        broken_call:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNo'
            - description: |
                Is it a broken call?
                Only the values `yes` and `no` are allowed.
        called_number:
          allOf:
            - $ref: '#/components/schemas/TraceTruncatedPhoneNumber'
            - description: |
                Truncated called phone number.
                Four last digits of the phone number.
        called_number_type:
          allOf:
            - $ref: '#/components/schemas/TraceNumberType'
            - description: Type of the called number.
        disengagement_id:
          allOf:
            - $ref: '#/components/schemas/TraceDisengagementToken'
            - description: |
                Disengagement id from the `P-Identity-Bypass` header.
                Mandatory if `provider_disengagement` is `yes`.
        displayed_number:
          allOf:
            - $ref: '#/components/schemas/TraceTruncatedPhoneAnonymeNumber'
            - description: |
                Truncated displayed phone number (from).
                Four last digits of the phone number or `anonymous`, `unavailable` or `invalid`.
        displayed_number_type:
          allOf:
            - $ref: '#/components/schemas/TraceNumberType'
            - description: Type of the displayed number.
        egress_provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                APNF Code of the provider who receive the call.
                Mandatory when `author_provider_role` is `transit` or `optv`, `null` otherwise.
        emergency_call:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNoUnknown'
            - description: |
                Is it an emergency call?
                Mandatory if `provider_disengagement` is `no`.
                Only the values `yes`, `no` and `unknown` are allowed.
        id:
          allOf:
            - $ref: '#/components/schemas/TraceId'
            - description: ID of the trace.
        identity_header:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNo'
            - description: |
                Is there an identity header?
                Only the values `yes` and `no` are allowed.
                Mandatory if `provider_disengagement` is `no`.
        opts:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                APNF Code of the Opts provider if exist, `null` otherwise.
        optv:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                APNF Code of the technical service provider for signature verification (OPTV).
                Mandatory when `author_provider_role` is `optv` or `optv_client`, `null` otherwise.
        pai:
          allOf:
            - $ref: '#/components/schemas/TraceTruncatedPhoneNumber'
            - description: |
                Truncated PAI phone number.
                Four last digits of the phone number.
        provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                Provider responsible for the trace.
                This field has the same value as `author_provider` if `author_provider_role` is
                `terminating`, `transit`, `optv_client` or `unknown`. Otherwise, it has the same
                value as `terminating_provider`.
        terminating_provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                APNF Code of the termination provider.
                Mandatory when `author_provider_role` is `optv`, `optv_client` or `terminating`,
                `null` otherwise.
        signatory_provider:
          allOf:
            - $ref: '#/components/schemas/TraceProviderCodeUnknown'
            - description: |
                APNF Code of the provider who emit the call.
        ingress_provider:
          allOf:
            - $ref: '#/components/schemas/TraceProviderCodeUnknown'
            - description: |
                APNF Code of the provider who emit the call.
        start_call_timestamp:
          type: string
          description: Timestamp of the call start. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
        provider_disengagement:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNo'
            - description: |
                Is the disengagement of the provider on its STI-AS activated ? (presence of the
                `P-Identity-Bypass` header)
                Only the values `yes` and `no` are allowed.
        redirected_call:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNoUnknown'
            - description: Unused property
        redirecting_number:
          allOf:
            - $ref: '#/components/schemas/TraceTruncatedPhoneAnonymeNumber'
            - description: Unused property
        redirected_provider:
          allOf:
            - $ref: '#/components/schemas/TraceProviderCodeUnknown'
            - description: Unused property
        sip_reject_code:
          type: integer
          description: |
            SIP reject code.
            Mandatory if `provider_disengagement` is `no`.
          example: 436
        sip_reject_subcode:
          type: string
          description: |
            SIP reject subcode.
            Mandatory if `provider_disengagement` is `no`.
          example: Bad Identity Info
        url:
          type: string
          description: |
            `info` field (certificate URL) from the identity header.
            Mandatory if `identity_header` is `yes`.
          format: uri
          example: https://man-bpco.fr/OPC000/57ABB34BCA510043BDE438460F13B27E6A82C004.cer
      required:
        - id
        - author_provider_role
        - author_provider
        - broken_call
        - called_number
        - called_number_type
        - displayed_number
        - displayed_number_type
        - ingress_provider
        - pai
        - provider
        - provider_disengagement
        - signatory_provider
        - start_call_timestamp
      type: object
    TraceDisengagementToken:
      type: string
      description: Disengagement token.
      pattern: ^IDENTITY-BYPASS-([0-9A-Z]{6})-([0-9A-Z\-]{1,16})$
      example: IDENTITY-BYPASS-OPC000-7WVF1P3NLZE8TL9R$
    TraceId:
      type: string
      description: Id of the trace.
    TraceNumberType:
      type: string
      description: Phone number type.
      enum:
        - fixe
        - mobile
        - other
      example: mobile
    TraceProviderCodeUnknown:
      type: string
      description: |
        Service Provider Code or `unknown`.
        Each service provider in France is assigned a unique code by the APNF.
      pattern: ^([0-9A-Z]{6}|unknown)$
      example: OPC000
    TraceProviderRole:
      type: string
      description: Role of the provider.
      enum:
        - transit
        - terminating
        - optv
        - optv_client
        - unknown
      example: transit
    TraceShakenAttestationLevel:
      type: string
      description: Shaken attestation level.
      enum:
        - A
        - B
        - C
      example: C
    TraceStateYesNo:
      type: string
      enum:
        - 'yes'
        - 'no'
      example: 'yes'
    TraceStateYesNoUnknown:
      type: string
      enum:
        - 'yes'
        - 'no'
        - unknown
      example: 'yes'
    TraceSummaryView:
      type: object
      description: |
        Traces data model (summary view).
      properties:
        attestation:
          allOf:
            - $ref: '#/components/schemas/TraceShakenAttestationLevel'
            - description: |
                Shaken attestation level.
                Mandatory if `identity_header` is `yes` and `author_provider_role` is different than
                `transit`.
        author_provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                Provider responsible who made the trace.
                This field has the same value as `author_provider` if `author_provider_role` is
                `terminating`, `transit`, `optv_client` or `unknown`. Otherwise, it has the same
                value as `terminating_provider`.
        author_provider_role:
          allOf:
            - $ref: '#/components/schemas/TraceProviderRole'
            - description: Role of the provider who made the trace.
        broken_call:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNo'
            - description: |
                Is it a broken call?
                Only the values `yes` and `no` are allowed.
        emergency_call:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNoUnknown'
            - description: |
                Is it an emergency call?
                Mandatory if `provider_disengagement` is `no`.
                Only the values `yes`, `no` and `unknown` are allowed.
        id:
          allOf:
            - $ref: '#/components/schemas/TraceId'
            - description: ID of the trace.
        identity_header:
          allOf:
            - $ref: '#/components/schemas/TraceStateYesNo'
            - description: |
                Is there an identity header?
                Only the values `yes` and `no` are allowed.
                Mandatory if `provider_disengagement` is `no`.
        provider:
          allOf:
            - $ref: '#/components/schemas/ProviderCode'
            - description: |
                Provider responsible for the trace.
                This field has the same value as `author_provider` if `author_provider_role` is
                `terminating`, `transit`, `optv_client` or `unknown`. Otherwise, it has the same
                value as `terminating_provider`.
        signatory_provider:
          allOf:
            - $ref: '#/components/schemas/TraceProviderCodeUnknown'
            - description: |
                APNF Code of the provider who emit the call.
        sip_reject_code:
          type: integer
          description: |
            SIP reject code.
            Mandatory if `provider_disengagement` is `no`.
          example: 436
        start_call_timestamp:
          type: string
          description: Timestamp of the call start. Date shall be in ISO-8601 format.
          format: date-time
          example: '2023-01-17T10:12:25Z'
      required:
        - author_provider_role
        - author_provider
        - broken_call
        - id
        - provider
        - signatory_provider
        - start_call_timestamp
    TraceTruncatedPhoneAnonymeNumber:
      type: string
      description: Four last digits of the phone number or `anonymous`, `unavailable` or `invalid`.
      pattern: ^([0-9]{4}|anonymous|unavailable|invalid)$
      example: 1234
    TraceTruncatedPhoneNumber:
      type: string
      description: Four last digits of the phone number.
      pattern: ^[0-9]{4}$
      example: 1234
    UUID:
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: 9d82a078-01cb-4a70-a529-14b7e57d4a21
    User:
      type: object
      description: User data model.
      required:
        - id
        - provider_id
        - firstname
        - lastname
        - email_address
        - mobile_phone
        - roles
        - status
        - deleted
        - created_at
        - created_by
        - updated_at
        - updated_by
      properties:
        id:
          $ref: '#/components/schemas/UserId'
        provider_id:
          allOf:
            - description: ID of the service provider linked to the user.
            - $ref: '#/components/schemas/ProviderId'
        firstname:
          type: string
          maxLength: 64
          description: User first name
          example: Jane
        lastname:
          type: string
          maxLength: 64
          description: User last name
          example: Doe
        email_address:
          type: string
          maxLength: 254
          description: User email address
          example: jane.doe@my.company
        mobile_phone:
          type: string
          maxLength: 32
          description: Mobile phone number
          example: '0102030405'
        language:
          allOf:
            - description: Language to be used in the UI for this user.
            - $ref: '#/components/schemas/Language'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
        status:
          $ref: '#/components/schemas/UserStatus'
        deleted:
          type: boolean
          description: |
            Deleted status.

            The deleted user do not have access anymore to the application; the count will be effectively removed after 3 months,
            and during that period a rollback of the delete action is possible using the `POST /users/{user_id}/undelete` API.
          default: false
          example: false
        last_connected_at:
          type: string
          description: User last connection date.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        created_by:
          type: string
          maxLength: 254
          description: |
            Origin of the create action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
            - `SYSTEM` if the action is performed by the platform
          example: John Doe <john.doe@spa.domain>
        updated_at:
          type: string
          description: |
            Last Update Date`.
            Initially set to the same value as `created_at`.
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_by:
          type: string
          maxLength: 254
          description: |
            Origin of the update action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
            - `SYSTEM` if the action is performed by the platform
          example: John Doe <john.doe@spa.domain>
        deleted_at:
          type: string
          description: Deletion date
          format: date-time
          nullable: true
          example: '2022-05-17T10:12:25Z'
        deleted_by:
          type: string
          maxLength: 254
          description: |
            Origin of the delete action. May be set to :
            - a user. The format shall be `<first name> <last name> <<email address>>`.
            - `API` if the action is triggered by an API call
            - `SYSTEM` if the action is performed by the platform
          nullable: true
          example: John Doe <john.doe@spa.domain>
        legal_administrator:
          type: boolean
          description: Determine is user is legal administrator or not.
    UserCreationRequest:
      type: object
      description: User creation request data model
      required:
        - firstname
        - lastname
        - email_address
        - roles
      properties:
        provider_id:
          allOf:
            - description: |
                Provider the user shall belong to.
                Shall be provided only when the account is created by a *MAN_ADMINISTRATOR* user.
            - $ref: '#/components/schemas/ProviderId'
        firstname:
          type: string
          maxLength: 64
          description: User first name
          example: Jane
        lastname:
          type: string
          maxLength: 64
          description: User last name
          example: Doe
        email_address:
          type: string
          maxLength: 254
          description: User email address
          example: john.doe@spa.domain
        mobile_phone:
          type: string
          maxLength: 20
          description: Mobile phone number
          example: '0102030405'
        language:
          allOf:
            - description: |
                Language to be used in the UI for this user.

                *Note:* The list of languages available to the user depends on the provider configuration.
            - $ref: '#/components/schemas/Language'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
    UserId:
      description: ID of the user. Must be unique.
      type: string
      format: uuid
      pattern: ^([0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12})$
      example: 155720a6-f4c9-40ec-b479-a32d7f062553
    UserPref:
      type: object
      description: Portal preferences of the user.
      properties:
        pagination_limit:
          type: integer
          description: Default number of resources per page
          minimum: 1
          default: 20
          maximum: 100
        show_menu:
          type: boolean
          description: Default menu visibility
          default: true
    UserRole:
      type: string
      description: |
        User role defining user permissions in the application.

        The following roles are for users not associated to a service provider:
         * A user with `MAN_ADMINISTRATOR` role has access to all functionalities to manage the platform.
         * A user with `APNF` role has access to all providers data in read-only mode.

        The following roles are for users associated to a service provider:
         * A user with `ADMINISTRATOR` role has access to all functionalities to manage a provider, their users and data.
         * A user with `MANAGER` role can view all provider and call authentication data and has access to APIs for managing STI certificates.
         * A user with `SUPERVISOR` role has access to all provider and call authentication data but in read-only mode.
         * A user with `DELEGATION_MANAGER` role can view all provider and display delegation data and has access to APIs for managing display delegations.
         * A user with `DELEGATION_SUPERVISOR` role has access to all provider and display delegation data but in read-only mode.
      enum:
        - MAN_ADMINISTRATOR
        - APNF
        - ADMINISTRATOR
        - MANAGER
        - SUPERVISOR
        - DELEGATION_MANAGER
        - DELEGATION_SUPERVISOR
      example: MANAGER
    UserStatus:
      type: string
      description: |
        User status. Following values are possible:

        - `PENDING`: the account has been created but the user has not yet activated the account
        - `ENABLED`: the account has been created and the user has activated the account
        - `DISABLED`: the account has been disabled. User cannot login to the platform.
      enum:
        - PENDING
        - ENABLED
        - DISABLED
      example: ENABLED
    UserSummaryView:
      type: object
      description: User (summary view) data model.
      required:
        - id
        - firstname
        - lastname
        - email_address
        - roles
        - status
        - deleted
        - created_at
        - updated_at
        - last_connected_at
      properties:
        id:
          $ref: '#/components/schemas/UserId'
        provider_id:
          allOf:
            - description: ID of the service provider linked to the user.
            - $ref: '#/components/schemas/ProviderId'
        firstname:
          type: string
          maxLength: 64
          description: User first name
          example: Jane
        lastname:
          type: string
          maxLength: 64
          description: User last name
          example: Doe
        email_address:
          type: string
          maxLength: 254
          description: User email address
          example: jane.doe@my.company
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserRole'
        status:
          $ref: '#/components/schemas/UserStatus'
        deleted:
          type: boolean
          description: |
            Deleted status.

            The deleted user do not have access anymore to the application; the count will be effectively removed after 3 months,
            and during that period a rollback of the delete action is possible using the `POST /users/{user_id}/undelete` API.
          default: false
          example: false
        created_at:
          type: string
          description: Creation Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        updated_at:
          type: string
          description: Last update Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
        last_connected_at:
          type: string
          description: Last connection Date
          format: date-time
          example: '2022-01-17T10:12:25Z'
  securitySchemes:
    access_token:
      type: http
      description: |
        APIs need to provide an access token created using the MAN Platform Authorization API and which complies with OpenID Connect protocol.
        Refer to the *MAN platform authorization API Reference* on how to generate these access tokens.
      scheme: bearer
      bearerFormat: JWT