FusionAuth

FusionAuth Connector API

The Connector API from FusionAuth — 2 operation(s) for connector.

GitHub OpenAPI

Operations 6

POST /api/connector #
POST /api/connector/{connectorId} #
DELETE /api/connector/{connectorId} #
PATCH /api/connector/{connectorId} #
GET /api/connector/{connectorId} #
PUT /api/connector/{connectorId} #

Documentation

📖
Documentation
https://fusionauth.io/docs/apis/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/fusionauth/refs/heads/main/openapi/fusionauth-connector-api-openapi.yml

Other Resources

🔗
SDKs
https://fusionauth.io/docs/sdks/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/fusionauth-connector-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

fusionauth-connector-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.66.0
  title: FusionAuth Api Key Connector API
  description: This is a FusionAuth server. Find out more at [https://fusionauth.io](https://fusionauth.io). You need to [set up an API key](https://fusionauth.io/docs/v1/tech/apis/authentication#managing-api-keys) in the FusionAuth instance you are using to test out the API calls.
  license:
    name: Apache2
servers:
- url: http://localhost:9011
- url: https://sandbox.fusionauth.io
security:
- ApiKeyAuth: []
tags:
- name: Connector
paths:
  /api/connector:
    post:
      description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
      operationId: createConnector
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Connector
  /api/connector/{connectorId}:
    post:
      description: Creates a connector.  You can optionally specify an Id for the connector, if not provided one will be generated.
      operationId: createConnectorWithId
      parameters:
      - name: connectorId
        in: path
        schema:
          type: string
        required: true
        description: The Id for the connector. If not provided a secure random UUID will be generated.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Connector
    delete:
      description: Deletes the connector for the given Id.
      operationId: deleteConnectorWithId
      parameters:
      - name: connectorId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the connector to delete.
      responses:
        '200':
          description: Success
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Connector
    patch:
      description: Updates, via PATCH, the connector with the given Id.
      operationId: patchConnectorWithId
      parameters:
      - name: connectorId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the connector to update.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Connector
    get:
      description: Retrieves the connector with the given Id.
      operationId: retrieveConnectorWithId
      parameters:
      - name: connectorId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the connector.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        default:
          description: Error
      tags:
      - Connector
    put:
      description: Updates the connector with the given Id.
      operationId: updateConnectorWithId
      parameters:
      - name: connectorId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the connector to update.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectorRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Connector
components:
  schemas:
    ConnectorRequest:
      description: ''
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/BaseConnectorConfiguration'
    ConnectorResponse:
      description: ''
      type: object
      properties:
        connector:
          $ref: '#/components/schemas/BaseConnectorConfiguration'
        connectors:
          type: array
          items:
            $ref: '#/components/schemas/BaseConnectorConfiguration'
    BaseConnectorConfiguration:
      description: Do not require a setter for 'type', it is defined by the concrete class and is not mutable
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          $ref: '#/components/schemas/ZonedDateTime'
        lastUpdateInstant:
          $ref: '#/components/schemas/ZonedDateTime'
        name:
          type: string
        type:
          $ref: '#/components/schemas/ConnectorType'
    Errors:
      description: Standard error domain object that can also be used as the response from an API call.
      type: object
      properties:
        fieldErrors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        generalErrors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ZonedDateTime:
      description: 'The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.'
      example: '1659380719000'
      type: integer
      format: int64
    Error:
      description: Defines an error.
      type: object
      properties:
        code:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        message:
          type: string
    ConnectorType:
      description: The types of connectors. This enum is stored as an ordinal on the <code>identities<code> table, order must be maintained.
      type: string
      enum:
      - FusionAuth
      - Generic
      - LDAP
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT