FusionAuth Connector API

openapi: 3.0.3
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:
    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
    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'
    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'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT