find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/infocert:infocert-mailboxes-configuration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Infocert Mailboxes Configuration API
  version: 1.0.0
  description: 'Operations tagged Mailboxes Configuration across 2 of this provider''s published API definitions: infocert-legalmail-business-provisioning-openapi.yml, infocert-legalmail-business-provisioning-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://mtlsapi.infocert.digital/api/v1
- url: https://mtlsapistage.infocert.digital/api/v1
- url: https://mtlsapitest.infocert.digital/api/v1
basePath: /identification/afm/v1
tags:
- name: Mailboxes Configuration
  description: Mailbox configuration related resources
paths:
  /configuration/mailboxes/{mailboxId}:
    get:
      tags:
      - Mailboxes Configuration
      summary: Configuration info of a Mailbox
      operationId: getMailboxConfiguration
      parameters:
      - $ref: '#/components/parameters/accountCode'
      - $ref: '#/components/parameters/mailboxId'
      responses:
        '200':
          description: Mailbox configurations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxConfiguration'
              example:
                data:
                - mailboxId: MBX12345
                  configType: CLOSURE
                  configParams:
                    closureType: FROM_ALL_TO_ALL
                - mailboxId: MBX54321
                  configType: MAILBOX_FILTER
                  configParams:
                    filterType: AUTO_REPLY_PEC
                    anotherFilterParam: another filter value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://mtlsapi.infocert.digital/api/v1
    - url: https://mtlsapistage.infocert.digital/api/v1
    - url: https://mtlsapitest.infocert.digital/api/v1
  /configuration/mailboxes:
    put:
      tags:
      - Mailboxes Configuration
      summary: Settings mailbox configuration - batch supported
      operationId: putConfigurationMailbox
      parameters:
      - $ref: '#/components/parameters/accountCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailboxConfiguration'
            example:
              data:
              - mailboxId: MBX12345
                configType: CLOSURE
                configParams:
                  closureType: FROM_ALL_TO_ALL
              - mailboxId: MBX54321
                configType: MAILBOX_FILTER
                configParams:
                  filterType: AUTO_REPLY_PEC
                  anotherFilterParam: another filter value
      responses:
        '200':
          description: Returns the Operation Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTokenResult'
              example:
                operationToken: 02b4a1e8-ab61-11ec-b909-0242ac120002
                operation: SET_MAILBOX_CONFIGURATION
                requestTimestamp: '2022-03-24T14:40:01.789Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://mtlsapi.infocert.digital/api/v1
    - url: https://mtlsapistage.infocert.digital/api/v1
    - url: https://mtlsapitest.infocert.digital/api/v1
components:
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: 'A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.

            '
          default: about:blank
          example: https://developers.infocert.digital/legalmail/errors/?code=LMAI00001
        title:
          type: string
          description: 'A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

            '
          example: Bad request
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          maximum: 600
          example: 400
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

            '
          example: Invalid request
        instance:
          type: string
          format: uri-reference
          description: 'A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.

            '
          example: /provisioning/users
        errorCode:
          type: string
          description: 'The error code. This is unique across all legalmail API. The type field contains the URI to the documentation regarding the error code.

            '
          example: LMAI00006
        violations:
          type: array
          description: 'A list populated with the appropriate description of errors. Usually populated in case of BadRequest errors after validation failures.

            '
          items:
            type: object
            properties:
              field:
                type: string
                example: pageSize
              in:
                type: string
                example: '?'
              message:
                type: string
                example: must be greater than or equal to 0
            required:
            - field
            - message
    MailboxOperationEnum:
      title: Mailbox Operation Action
      description: Mailbox Operation Action
      type: string
      enum:
      - CREATE_MAILBOX
      - EDIT_MAILBOX
      - ADD_SERVICES
      - EDIT_SERVICES
      - TRANSFORM_MAILBOX
      - CREATE_SECONDARY_USERS
      - CREATE_IDENTITIES
      - DO_ACTION_ON_USER
      - SET_MAILBOX_CONFIGURATION
      - ADD_USER_ACCESS_TO_MAILBOX
      - DELETE_USER_ACCESS_TO_MAILBOX
      - CHANGE_USERS_PASSWORD
      - CHANGE_MAILBOXES_PASSWORD
    MailboxConfigData:
      title: Mailbox Configuration Data
      description: Mailbox Configuration Data
      properties:
        mailboxId:
          type: string
          example: MBX12345
        configType:
          $ref: '#/components/schemas/MailboxConfigurationType'
        configParams:
          anyOf:
          - $ref: '#/components/schemas/ClosureConfigParams'
          - $ref: '#/components/schemas/MailboxFilterConfigParams'
      required:
      - mailboxId
    ClosureConfigParams:
      title: Closure config params
      type: object
      properties:
        closureType:
          $ref: '#/components/schemas/ClosureTypeEnum'
        customDsnMessage:
          description: Custom DSN message to reply to PEO sender. Only active when ClosureType supports Custom DSN messages
          type: string
          example: Ciao, questa casella è disattivata
        customDsnMessageHTML:
          description: Custom DSN message as HTML to reply to PEO sender. Only active when ClosureType supports Custom DSN messages
          type: string
          example: Ciao,<br/>questa casella è disattivata<br/>e risponde con un messaggio HTML!
      required:
      - closureType
    MailboxFilterTypeEnum:
      title: Mailbox filter type
      type: string
      enum:
      - AUTO_REPLY_PEC
    OperationTokenResult:
      title: Operation Token
      description: An operation has been acquired by the system and an operation token is returned
      properties:
        requestTimestamp:
          type: string
          description: the request timestamp
          format: date-time
        operationToken:
          type: string
          description: a UUID to identify the operation
          format: UUID
          example: 02b4a1e8-ab61-11ec-b909-0242ac120002
        operation:
          $ref: '#/components/schemas/MailboxOperationEnum'
        status:
          $ref: '#/components/schemas/OperationStatus'
        executionTimestamp:
          type: string
          description: The final execution time (every part of the request has reached a final status)
          format: date-time
        modifiedTimestamp:
          type: string
          description: The last modification time of token or one of its parts
          format: date-time
      required:
      - requestTimestamp
      - operationToken
      - operation
    OperationStatus:
      title: Operation Status
      description: The status of the operation
      type: string
      enum:
      - PENDING
      - DONE
      - ERROR
    MailboxConfiguration:
      title: Mailbox Configuration
      description: Mailbox Configuration
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MailboxConfigData'
    MailboxFilterConfigParams:
      title: Mailbox filter config params
      type: object
      properties:
        filterType:
          $ref: '#/components/schemas/MailboxFilterTypeEnum'
        anotherFilterParam:
          type: string
          example: this is a sample params, actual params are yet to be confirmed
    ClosureTypeEnum:
      title: Closure type
      description: "A mailbox can be configured to accept or send only specific types of certified/non-certified messages.\n  - FROM_ALL_TO_ALL : can send and receive from and to any address\n  - FROM_PEC_TO_ALL : can send to any and receive only from other certified addresses\n  - FROM_PEC_TO_PEC : can only send and receive from/to certified addresses\n  - FROM_DOMAIN_TO_PEC : can only receive from addresses within the same domain, and only send to other certified addresses\n  - FROM_DOMAIN_TO_DOMAIN : can only receive or send within the same domain\n  - FROM_DOMAIN_TO_ALL : an only receive from addresses within the same domain, and send to any kind of address\n  - RECEIVE_ONLY : can only receive messages\n  - SEND_ONLY : can only send messages\n  - FROM_PEC_RECEIVE_ONLY : can only receive messages from certified addresses\n"
      type: string
      enum:
      - FROM_ALL_TO_ALL
      - FROM_PEC_TO_ALL
      - FROM_PEC_TO_PEC
      - FROM_DOMAIN_TO_PEC
      - FROM_DOMAIN_TO_DOMAIN
      - FROM_DOMAIN_TO_ALL
      - RECEIVE_ONLY
      - SEND_ONLY
      - FROM_PEC_RECEIVE_ONLY
    MailboxConfigurationType:
      title: Mailbox Configuration
      description: Mailbox Configuration
      type: string
      enum:
      - CLOSURE
      - MAILBOX_FILTER
  responses:
    Unauthorized:
      description: Not Authorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    BadRequest:
      description: Bad request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  parameters:
    accountCode:
      in: header
      name: IC-Legalmail-AccountCode
      description: 'Account code you want to operate on. Must be an account of the authenticated client.

        '
      schema:
        type: string
      required: true
      example: '214578'
    mailboxId:
      name: mailboxId
      in: path
      schema:
        type: string
        description: The mailbox id
      required: true
externalDocs:
  description: Find out more about Legalmail in the InfoCert Digital website
  url: https://infocert.digital
x-refined-from:
- infocert-legalmail-business-provisioning-openapi.yml
- infocert-legalmail-business-provisioning-openapi.yml