FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
  • 5-Minute Setup Guide
  • Release Notes
  • Core Concepts
    • Overview
    • Users
    • Roles
    • Groups
    • Entity Management
    • Registrations
    • Applications
    • Tenants
    • Identity Providers
    • Key Master
    • SCIM
    • Search
    • Authentication and Authorization
    • Integration Points
    • Localization and Internationalization
    • Editions and Features
    • Roadmap
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Admin Guide
    • Overview
    • Config Management
    • Licensing
    • Monitoring
    • Proxy Setup
    • Securing
    • Technical Support
    • Troubleshooting
    • Upgrading
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Tutorial
  • APIs
    • Overview
    • Authentication
    • Errors
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Kafka
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM EnterpriseUser
      • SCIM Group
      • SCIM Service Provider Config.
      • SCIM User
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • Webhooks
  • Client Libraries
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • Node
    • OpenAPI
    • PHP
    • Python
    • Ruby
    • Typescript
  • Themes
    • Overview
    • Examples
    • Helpers
    • Localization
    • Template Variables
  • Email & Templates
    • Overview
    • Configure Email
    • Email Templates
    • Email Variables
    • Message Templates
  • Events & Webhooks
    • Overview
    • Writing a Webhook
    • Securing Webhooks
    • Events
      • Overview
      • Audit Log Create
      • Event Log Create
      • JWT Public Key Update
      • JWT Refresh
      • JWT Refresh Token Revoke
      • Kickstart Success
      • User Action
      • User Bulk Create
      • User Create
      • User Create Complete
      • User Deactivate
      • User Delete
      • User Delete Complete
      • User Email Update
      • User Email Verified
      • User IdP Link
      • User IdP Unlink
      • User Login Failed
      • User Login Id Duplicate Create
      • User Login Id Duplicate Update
      • User Login New Device
      • User Login Success
      • User Login Suspicious
      • User Password Breach
      • User Password Reset Send
      • User Password Reset Start
      • User Password Reset Success
      • User Password Update
      • User Reactivate
      • User Registration Create
      • User Registration Create Complete
      • User Registration Delete
      • User Registration Delete Complete
      • User Registration Update
      • User Registration Update Complete
      • User Registration Verified
      • User Two Factor Method Add
      • User Two Factor Method Remove
      • User Update
      • User Update Complete
  • Example Apps
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • PHP
    • Python
    • Ruby
  • Lambdas
    • Overview
    • Apple Reconcile
    • Client Cred. JWT Populate
    • Epic Games Reconcile
    • External JWT Reconcile
    • Facebook Reconcile
    • Google Reconcile
    • HYPR Reconcile
    • JWT Populate
    • LDAP Connector Reconcile
    • LinkedIn Reconcile
    • Nintendo Reconcile
    • OpenID Connect Reconcile
    • SAML v2 Populate
    • SAML v2 Reconcile
    • SCIM Group Req. Converter
    • SCIM Group Resp. Converter
    • SCIM User Req. Converter
    • SCIM User Resp. Converter
    • Sony PSN Reconcile
    • Steam Reconcile
    • Twitch Reconcile
    • Twitter Reconcile
    • Xbox Reconcile
  • Identity Providers
    • Overview
    • Apple
    • Epic Games
    • External JWT
      • Overview
      • Example
    • Facebook
    • Google
    • HYPR
    • LinkedIn
    • Nintendo
    • OpenID Connect
      • Overview
      • Azure AD
      • Discord
      • Github
    • Sony PlayStation Network
    • Steam
    • Twitch
    • Twitter
    • SAML v2
      • Overview
      • ADFS
    • SAML v2 IdP Initiated
      • Overview
      • Okta
    • Xbox
  • Messengers
    • Overview
    • Generic Messenger
    • Kafka Messenger
    • Twilio Messenger
  • Connectors
    • Overview
    • Generic Connector
    • LDAP Connector
    • FusionAuth Connector
  • Self Service Account Mgmt
    • Overview
    • Updating User Data & Password
    • Add Two-Factor Authenticator
    • Add Two-Factor Email
    • Add Two-Factor SMS
    • Customizing
    • Troubleshooting
  • Advanced Threat Detection
    • Overview
  • Integrations
    • Overview
    • CleanSpeak
    • Kafka
    • Twilio
  • OpenID Connect & OAuth 2.0
    • Overview
    • Endpoints
    • Tokens
  • SAML v2 IdP
    • Overview
    • Google
    • Zendesk
  • Plugins
    • Plugins
    • Writing a Plugin
    • Custom Password Hashing
  • Guides
    • Overview
    • Advanced Registration Forms
    • Breached Password Detection
    • Multi-Factor Authentication
    • Multi-Tenant
    • Passwordless
    • Securing Your APIs
    • Silent Mode
    • Single Sign-on
  • Tutorials
    • Overview
    • User Control & Gating
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
    • Setup Wizard & First Login
    • Register/Login a User
    • Start and Stop FusionAuth
    • Authentication Tokens
    • Key Rotation
    • JSON Web Tokens
    • Prometheus Setup
    • Switch Search Engines
    • Two Factor (pre 1.26)
  • Reference
    • CORS
    • Configuration
    • Data Types
    • Known Limitations
    • Password Hashes

    Kafka Messenger APIs

    Overview

    This API has been available since 1.26.0

    The following APIs are provided to manage Kafka Messengers.

    Operations

    • Create the Kafka Messenger

    • Retrieve the Kafka Messenger

    • Update the Kafka Messenger

    • Delete the Kafka Messenger

    Create the Kafka Messenger

    Request

    Create a Kafka Messenger with a randomly generated Id.

    URI

    POST /api/messenger

    Create a Kafka Messenger with the provided unique Id.

    URI

    POST /api/messenger/{messengerId}

    The type in the request JSON is used to determine that you are creating the Kafka Messenger.

    Request Parameters

    messengerId [UUID] Optional defaults to secure random UUID

    The Id to use for the new Messenger. If not specified a secure random UUID will be generated.

    Request Body

    messenger.data [Object] Optional

    An object that can hold any information about the Messenger that should be persisted.

    messenger.debug [Boolean] Optional defaults to false

    If debug is enabled, an event log is created to assist in debugging messenger errors.

    messenger.defaultTopic [String] Required

    The name of the Kafka topic to send messages.

    messenger.name [String] Required

    The unique Messenger name.

    messenger.producer [Map<String, String>] Optional

    String key value pairs to be used when building the Kafka Producer.

    Example Request JSON
    {
      "messenger" : {
        "data" : {
          "foo" : "bar"
        },
        "debug": false,
        "defaultTopic": "test-topic",
        "name" : "Kafka Messenger",
        "producer": {
          "bootstrap.servers": "localhost:9092",
          "max.block.ms": "5000",
          "request.timeout.ms": "2000"
        },
        "type" : "Kafka"
      }
    }

    Response

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messenger.data [Object]

    An object that can hold any information about the Messenger that should be persisted.

    messenger.debug [Boolean]

    If debug is enabled, an event log is created to assist in debugging messenger errors.

    messenger.defaultTopic [String]

    The name of the Kafka topic to send messages.

    messenger.id [UUID]

    The unique Id of the Messenger.

    messenger.insertInstant [Long]

    The instant that the Messenger was added to the FusionAuth database.

    messenger.lastUpdateInstant [Long]

    The instant that the Messenger was last updated in the FusionAuth database.

    messenger.name [String]

    The unique Messenger name.

    messenger.producer [Map<String, String>]

    String key value pairs to be used when building the Kafka Producer.

    messenger.transport [String]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    messenger.type [String]

    This field will always be Kafka.

    Example Request JSON
    {
      "messenger": {
        "data" : {
          "foo" : "bar"
        },
        "debug": false,
        "defaultTopic": "test-topic",
        "id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
        "insertInstant": 1562189072183,
        "lastUpdateInstant": 1562189072183,
        "name": "Kafka Messenger",
        "producer": {
          "bootstrap.servers": "localhost:9092",
          "max.block.ms": "5000",
          "request.timeout.ms": "2000"
        },
        "transport" : "sms",
        "type": "Kafka"
      }
    }

    Retrieve the Kafka Messenger

    Request

    Retrieve the Kafka Messenger by Id

    URI

    GET /api/messenger/{messengerId}

    Request Parameters

    messengerId [UUID] Required

    The Id of the Messenger to retrieve.

    Response

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messenger.data [Object]

    An object that can hold any information about the Messenger that should be persisted.

    messenger.debug [Boolean]

    If debug is enabled, an event log is created to assist in debugging messenger errors.

    messenger.defaultTopic [String]

    The name of the Kafka topic to send messages.

    messenger.id [UUID]

    The unique Id of the Messenger.

    messenger.insertInstant [Long]

    The instant that the Messenger was added to the FusionAuth database.

    messenger.lastUpdateInstant [Long]

    The instant that the Messenger was last updated in the FusionAuth database.

    messenger.name [String]

    The unique Messenger name.

    messenger.producer [Map<String, String>]

    String key value pairs to be used when building the Kafka Producer.

    messenger.transport [String]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    messenger.type [String]

    This field will always be Kafka.

    Example Request JSON
    {
      "messenger": {
        "data" : {
          "foo" : "bar"
        },
        "debug": false,
        "defaultTopic": "test-topic",
        "id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
        "insertInstant": 1562189072183,
        "lastUpdateInstant": 1562189072183,
        "name": "Kafka Messenger",
        "producer": {
          "bootstrap.servers": "localhost:9092",
          "max.block.ms": "5000",
          "request.timeout.ms": "2000"
        },
        "transport" : "sms",
        "type": "Kafka"
      }
    }

    Update the Kafka Messenger

    This API is used to update an existing Kafka Messenger.

    You must specify the Id of the Kafka Messenger you are updating on the URI.

    You must specify all of the properties of the Kafka Messenger when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Kafka Messenger and your new data. It replaces the existing Kafka Messenger with your new data.

    Utilize the PATCH HTTP method to send specific changes to merge into an existing Kafka Messenger.

    Request

    Update the Kafka Messenger by Id

    URI

    PUT /api/messenger/{messengerId}

    PATCH /api/messenger/{messengerId}

    Available since 1.12.0

    When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

     

    Request Parameters

    messengerId [UUID] Required

    The Id of the Messenger to update.

    Request Body

    messenger.data [Object] Optional

    An object that can hold any information about the Messenger that should be persisted.

    messenger.debug [Boolean] Optional defaults to false

    If debug is enabled, an event log is created to assist in debugging messenger errors.

    messenger.defaultTopic [String] Required

    The name of the Kafka topic to send messages.

    messenger.name [String] Required

    The unique Messenger name.

    messenger.producer [Map<String, String>] Optional

    String key value pairs to be used when building the Kafka Producer.

    Example Request JSON
    {
      "messenger" : {
        "data" : {
          "foo" : "bar"
        },
        "debug": false,
        "defaultTopic": "test-topic",
        "name" : "Kafka Messenger",
        "producer": {
          "bootstrap.servers": "localhost:9092",
          "max.block.ms": "5000",
          "request.timeout.ms": "2000"
        },
        "type" : "Kafka"
      }
    }

    Response

    The response for this API contains the Kafka Messenger.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messenger.data [Object]

    An object that can hold any information about the Messenger that should be persisted.

    messenger.debug [Boolean]

    If debug is enabled, an event log is created to assist in debugging messenger errors.

    messenger.defaultTopic [String]

    The name of the Kafka topic to send messages.

    messenger.id [UUID]

    The unique Id of the Messenger.

    messenger.insertInstant [Long]

    The instant that the Messenger was added to the FusionAuth database.

    messenger.lastUpdateInstant [Long]

    The instant that the Messenger was last updated in the FusionAuth database.

    messenger.name [String]

    The unique Messenger name.

    messenger.producer [Map<String, String>]

    String key value pairs to be used when building the Kafka Producer.

    messenger.transport [String]

    The message transport protocol used to send a message. This value is currently read-only and set to sms.

    messenger.type [String]

    This field will always be Kafka.

    Example Request JSON
    {
      "messenger": {
        "data" : {
          "foo" : "bar"
        },
        "debug": false,
        "defaultTopic": "test-topic",
        "id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
        "insertInstant": 1562189072183,
        "lastUpdateInstant": 1562189072183,
        "name": "Kafka Messenger",
        "producer": {
          "bootstrap.servers": "localhost:9092",
          "max.block.ms": "5000",
          "request.timeout.ms": "2000"
        },
        "transport" : "sms",
        "type": "Kafka"
      }
    }

    Delete the Kafka Messenger

    Request

    Delete the Kafka Messenger by Id

    URI

    DELETE /api/messenger/{messengerId}

    messengerId [UUID] Required

    The Id of the Messenger to delete.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    © 2021 FusionAuth
    Subscribe for developer updates