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-provisioning-password-handling-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 Provisioning Password handling API
  version: 1.0.0
  description: 'Operations tagged Provisioning Password handling 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: Provisioning Password handling
  description: Resources to change passwords for mailboxes and users (secondary or identities)
paths:
  /provisioning/users/password:
    post:
      tags:
      - Provisioning Password handling
      summary: Changing passwords for users - batch supported
      description: 'Password change can either be:

        - password forcing (CHOOSE_PASSWORD) with new password passed as parameter

        - password reset (SEND_EMAIL) with a reset email sent to the user


        Secondary users do not support password reset, only password forcing.'
      operationId: changeIdentityPassword
      parameters:
      - $ref: '#/components/parameters/accountCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUsersPasswordRequest'
      responses:
        '200':
          description: Returns the Operation Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTokenResult'
              example:
                operationToken: 02b4a1e8-ab61-11ec-b909-0242ac120002
                operation: CHANGE_USERS_PASSWORD
                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
  /provisioning/mailboxes/password:
    post:
      tags:
      - Provisioning Password handling
      summary: Changing passwords for mailboxes - batch supported
      description: 'Password change can either be:

        - password forcing with new password passed as parameter

        - password reset with a reset email sent to the user'
      operationId: changeMailboxesPassword
      parameters:
      - $ref: '#/components/parameters/accountCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUsersPasswordRequest'
      responses:
        '200':
          description: Returns the Operation Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTokenResult'
              example:
                operationToken: 02b4a1e8-ab61-11ec-b909-0242ac120002
                operation: CHANGE_MAILBOXES_PASSWORD
                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
  /provisioning/mailboxes/resetpassword:
    put:
      tags:
      - Provisioning Password handling
      summary: Send password reset link to a custom mail - batch supported
      description: Send password reset link to a custom mail. This operation do a reset password and a reset of security contacts info
      operationId: resetMailboxesPassword
      parameters:
      - $ref: '#/components/parameters/accountCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetUsersPasswordRequestAndSendRecoveryMailToCustomMail'
      responses:
        '200':
          description: Returns the Operation Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationTokenResult'
              example:
                operationToken: 02b4a1e8-ab61-11ec-b909-0242ac120002
                operation: RESET_MAILBOXES_PASSWORD
                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:
    BatchUsersPasswordRequest:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserPasswordRequest'
      example:
        data:
        - userId: H123123
          forcingType: CHOOSE_PASSWORD
          password: a new password!
        - userId: M543543
          forcingType: SEND_EMAIL
    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
    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
    UserPasswordRequest:
      properties:
        userId:
          type: string
          description: userId that identifies identity or secondary user to update
          example: user1234
        forcingType:
          type: string
          description: action on the user
          enum:
          - SEND_EMAIL
          - CHOOSE_PASSWORD
          example: CHOOSE_PASSWORD
        password:
          description: new password to set if forcingType is CHOOSE_PASSWORD
          type: string
          example: genericPassword!
      required:
      - userId
      - forcingType
    ResetUsersPasswordRequestAndSendRecoveryMailToCustomMail:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResetPasswordRequest'
      example:
        data:
        - userId: H123123
          forcingType: RESET_PASSWORD
          recoveryCustomMail: nome.cognome@domain.example
    ResetPasswordRequest:
      properties:
        userId:
          type: string
          description: userId that identifies identity or secondary user to update
          example: user1234
        forcingType:
          type: string
          description: action on the user
          enum:
          - RESET_PASSWORD
          example: RESET_PASSWORD
        recoveryCustomMail:
          description: email address to send recovery link to
          type: string
          example: nome.congnome@domain.example
      required:
      - userId
      - forcingType
      - recoveryCustomMail
  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'
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