FusionAuth Messenger API

openapi: 3.0.3
info:
  version: 1.66.0
  title: FusionAuth Api Key Messenger 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: Messenger
paths:
  /api/messenger:
    post:
      description: Creates a messenger.  You can optionally specify an Id for the messenger, if not provided one will be generated.
      operationId: createMessenger
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessengerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessengerResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Messenger
  /api/messenger/{messengerId}:
    post:
      description: Creates a messenger.  You can optionally specify an Id for the messenger, if not provided one will be generated.
      operationId: createMessengerWithId
      parameters:
      - name: messengerId
        in: path
        schema:
          type: string
        required: true
        description: The Id for the messenger. If not provided a secure random UUID will be generated.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessengerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessengerResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Messenger
    delete:
      description: Deletes the messenger for the given Id.
      operationId: deleteMessengerWithId
      parameters:
      - name: messengerId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the messenger to delete.
      responses:
        '200':
          description: Success
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Messenger
    patch:
      description: Updates, via PATCH, the messenger with the given Id.
      operationId: patchMessengerWithId
      parameters:
      - name: messengerId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the messenger to update.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessengerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessengerResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Messenger
    get:
      description: Retrieves the messenger with the given Id.
      operationId: retrieveMessengerWithId
      parameters:
      - name: messengerId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the messenger.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessengerResponse'
        default:
          description: Error
      tags:
      - Messenger
    put:
      description: Updates the messenger with the given Id.
      operationId: updateMessengerWithId
      parameters:
      - name: messengerId
        in: path
        schema:
          type: string
        required: true
        description: The Id of the messenger to update.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessengerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessengerResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - Messenger
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
    MessengerResponse:
      description: ''
      type: object
      properties:
        messenger:
          $ref: '#/components/schemas/BaseMessengerConfiguration'
        messengers:
          type: array
          items:
            $ref: '#/components/schemas/BaseMessengerConfiguration'
    BaseMessengerConfiguration:
      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'
        messageTypes:
          type: array
          uniqueItems: true
          items: {}
        name:
          type: string
        transport:
          type: string
        type:
          $ref: '#/components/schemas/MessengerType'
    MessengerType:
      description: ''
      type: string
      enum:
      - Generic
      - Kafka
      - Twilio
    MessengerRequest:
      description: ''
      type: object
      properties:
        messenger:
          $ref: '#/components/schemas/BaseMessengerConfiguration'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT