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/modoboa:modoboa-identities-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: Modoboa Identities API
  version: v2
servers:
- url: https://demo.modoboa.org/api/schema-v2/
  description: Remote Demo server
- url: https://localhost:5000/api/schema-v2/
  description: Local server
tags:
- name: Identities
paths:
  /api/v2/identities/:
    get:
      operationId: identities_list
      description: Return all identities.
      tags:
      - Identities
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Identity'
          description: ''
      summary: Identities list
      x-summary-source: derived
  /api/v2/identities/export/:
    get:
      operationId: identities_export_retrieve
      description: Export accounts and aliases to CSV.
      tags:
      - Identities
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
      summary: Identities export retrieve
      x-summary-source: derived
  /api/v2/identities/import/:
    post:
      operationId: identities_import_create
      description: Import accounts and aliases from CSV file.
      tags:
      - Identities
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CSVIdentityImport'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CSVIdentityImport'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          description: No response body
      summary: Identities import create
      x-summary-source: derived
components:
  schemas:
    CSVIdentityImport:
      type: object
      description: Custom serializer for identity import.
      properties:
        sourcefile:
          type: string
          format: uri
        sepchar:
          type: string
          default: ;
        continue_if_exists:
          type: boolean
          default: false
        crypt_passwords:
          type: boolean
          default: false
      required:
      - sourcefile
    Identity:
      type: object
      description: Serializer used for identities.
      properties:
        pk:
          type: integer
        type:
          type: string
        identity:
          type: string
        name_or_rcpt:
          type: string
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        enabled:
          type: boolean
        possible_actions:
          type: string
          readOnly: true
      required:
      - enabled
      - identity
      - name_or_rcpt
      - pk
      - possible_actions
      - tags
      - type
    Tag:
      type: object
      description: Serializer used to represent a tag.
      properties:
        name:
          type: string
        label:
          type: string
        type:
          type: string
      required:
      - label
      - name
      - type
  securitySchemes:
    oauth2:
      type: oauth2
      flows: {}
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"