openapi: 3.2.0
info:
  title: Fenergo E Signature Configuration API
  version: '1.0'
  description: 'Operations tagged ESignatureConfiguration across 3 of this provider''s published API definitions: fenergo-documentmanagementcommand-v1-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json, fenergo-documentmanagementquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /documentmanagementcommand
- url: /documentmanagementquery
security:
- Bearer: []
tags:
- name: ESignatureConfiguration
paths:
  /api/esignatureconfiguration/provider/{providerId}/status:
    put:
      tags:
      - ESignatureConfiguration
      summary: Save Provider status
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: SaveProviderStatus
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/esignatureconfiguration/provider/{providerId}/configuration:
    put:
      tags:
      - ESignatureConfiguration
      summary: Save Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: SaveProviderConfiguration
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
      responses:
        '202':
          description: Success. Provider added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/esignatureconfiguration/provider/{providerId}/refreshLookups:
    put:
      tags:
      - ESignatureConfiguration
      summary: Refresh IDV Provider List
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: refreshLookups
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Provider added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignatureconfiguration/provider/{providerId}/status:
    put:
      tags:
      - ESignatureConfiguration
      summary: Save Provider status
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: putApiV2EsignatureconfigurationProviderByProviderIdStatus
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/BooleanServiceRequest'
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: SaveProviderStatus
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignatureconfiguration/provider/{providerId}/configuration:
    put:
      tags:
      - ESignatureConfiguration
      summary: Save Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: putApiV2EsignatureconfigurationProviderByProviderIdConfiguration
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ProviderConfigurationDtoServiceRequest'
      responses:
        '202':
          description: Success. Provider added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: SaveProviderConfiguration
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignatureconfiguration/provider/{providerId}/refreshLookups:
    put:
      tags:
      - ESignatureConfiguration
      summary: Refresh IDV Provider List
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: putApiV2EsignatureconfigurationProviderByProviderIdRefreshLookups
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Provider added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: refreshLookups
    servers:
    - url: /documentmanagementcommand
  /api/esignatureconfiguration:
    get:
      tags:
      - ESignatureConfiguration
      summary: Get Configuration
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: GetConfiguration
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.eSignatureConfiguration.ConfigurationDto class containing configuration information.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ConfigurationDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ConfigurationDtoServiceResponse'
        '400':
          description: Invalid request.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementquery
  /api/esignatureconfiguration/provider/{providerId}:
    get:
      tags:
      - ESignatureConfiguration
      summary: Get provider configuration
      description: 'This method returns specific eSignature provider


        Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      operationId: GetProviderConfiguration
      parameters:
      - name: providerId
        in: path
        description: The ID of provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Instance of Fenergo.Nebula.DocumentManagement.Query.Application.Dto.eSignatureConfiguration.ProviderConfigurationDto class containing provider configuration information.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigurationDtoServiceResponse'
        '400':
          description: Invalid request.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: There is no provider with given id
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementquery
  /api/esignatureconfiguration/provider/{providerId}/refreshSignatureProviders:
    get:
      tags:
      - ESignatureConfiguration
      summary: Refresh Signature Provider List
      description: 'Required permissions:

        Following permissions are required: ESignatureConfigurationAccess'
      parameters:
      - name: providerId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Provider added
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SignatureProviderRefreshResponseServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureProviderRefreshResponseServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/SignatureProviderRefreshResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      operationId: getApiEsignatureconfigurationProviderByProviderIdRefreshSignatureProviders
      x-operation-id-source: derived
    servers:
    - url: /documentmanagementquery
components:
  schemas:
    ESignatureLookupValue:
      type: object
      properties:
        label:
          type:
          - string
          - 'null'
        value: {}
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ESignatureLookup:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        values:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookupValue'
      additionalProperties: false
    SaveProviderConfigurationLookupsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SaveProviderConfigurationLookupsResponseDto'
          description: DTO representing response after saving the provider configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SaveProviderConfigurationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SaveProviderConfigurationResponseDto'
          description: DTO representing response after saving the provider configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BooleanServiceRequest:
      type: object
      properties:
        data:
          type: boolean
      additionalProperties: false
    SaveProviderConfigurationLookupsResponseDto:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: Provider Status
        enabled:
          type: boolean
          description: Is Provider Enabled
        errorMessage:
          type:
          - string
          - 'null'
          description: Optional user readable error message
        lookups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookup'
      additionalProperties: false
      description: DTO representing response after saving the provider configuration
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ProviderConfigurationDto:
      type: object
      properties:
        configuration:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
          description: Dictionary with provider configuration settings
      additionalProperties: false
      description: DTO representing provider configuration
    SaveProviderConfigurationResponseDto:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: Provider Status
        enabled:
          type: boolean
          description: Is Provider Enabled
        errorMessage:
          type:
          - string
          - 'null'
          description: Optional user readable error message
      additionalProperties: false
      description: DTO representing response after saving the provider configuration
    ProviderConfigurationDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProviderConfigurationDto'
          description: DTO representing provider configuration
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValueType:
      enum:
      - StringMultiline
      - String
      - Number
      - Boolean
      - List
      - MultiSelect
      type: string
    DocuSignGenericProviderDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
      additionalProperties: false
    ConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ConfigurationDto'
          description: Class which representing configuration providers
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ConfigurationDto:
      type: object
      properties:
        providersConfiguration:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ProviderConfigurationDto_2'
          description: Collection of configured providers
      additionalProperties: false
      description: Class which representing configuration providers
    SignatureProviderRefreshResponse:
      type: object
      properties:
        providers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocuSignGenericProviderDto'
      additionalProperties: false
    SchemaEntry:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        value: {}
        type:
          allOf:
          - $ref: '#/components/schemas/ValueType'
        masked:
          type: boolean
        nullable:
          type: boolean
        mandatory:
          type: boolean
        readOnly:
          type: boolean
      additionalProperties: false
    ProviderConfigurationDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ProviderConfigurationDto_2'
          description: DTO representing provider configuration
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ProviderConfigurationDto_2:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the provider
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        name:
          type:
          - string
          - 'null'
          description: The name of the provider
          example: DocuSign
        status:
          type:
          - string
          - 'null'
          description: The status of the provider
          example: Active
        enabled:
          type: boolean
          description: The flag which indicates if provider has been enabled
        localConfiguration:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SchemaEntry'
          description: Collection of local configuration parameters
        globalConfiguration:
          type:
          - object
          - 'null'
          additionalProperties: {}
          description: Collection of global configuration parameters
        lookups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ESignatureLookup'
      additionalProperties: false
      description: DTO representing provider configuration
    SignatureProviderRefreshResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SignatureProviderRefreshResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-documentmanagementcommand-v1-0-openapi.json
- fenergo-documentmanagementcommand-v2-0-openapi.json
- fenergo-documentmanagementquery-v1-0-openapi.json