FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • 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
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • 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
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • 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 Dup. Create
        • User Login Id Dup. 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 Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • 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. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • 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
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    Integration APIs

    Overview

    This page contains the APIs that are used for retrieving and updating integrations. An integration is a third party API that has been integrated into FusionAuth. These APIs are used to enable and configure these third party integration.

    This API underwent breaking changes in version 1.26. Twilio integrations are now managed by the

    Messengers API.

    • Retrieve Integrations

    • Update Integrations

    Retrieve Integrations

    This API is used to retrieve integrations.

    Request

    Retrieve Integrations

    URI

    GET /api/integration

    Response

    The response for this API contains the Integrations.

    Table 1. Response Codes
    Code Description

    200

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

    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.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    integration.cleanspeak.apiKey [String]

    The API key that is used when calling CleanSpeak for moderation.

    integration.cleanspeak.enabled [Boolean]

    True if CleanSpeak integration is enabled.

    integration.cleanspeak.url [String]

    The URL of the CleanSpeak WebService service (i.e. http://localhost:8001/).

    integration.cleanspeak.usernameModeration.applicationId [UUID]

    The Id of the CleanSpeak Application where usernames are sent for moderation.

    integration.cleanspeak.usernameModeration.enabled [Boolean]

    True if CleanSpeak username moderation is enabled.

    integration.kafka.defaultTopic [String]

    The name of the Kafka topic to send messages.

    integration.kafka.enabled [Boolean]

    True if the Kafka integration is enabled.

    integration.kafka.producer [Map<String, String>]

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

    integration.twilio.accountSID [String] Deprecated

    The Twilio Account ID to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.authToken [String] Deprecated

    The Twilio Auth Token to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.enabled [Boolean] Deprecated

    True if the Twilio integration is enabled.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.fromPhoneNumber [String] Deprecated

    The configured Twilio phone number that will be used to send messages. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.messagingServiceSid [String] Deprecated

    The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers. This can be found in your Twilio dashboard.

    When using the Twilio Messaging Services Id, you may omit the fromPhoneNumber field.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    Example Response JSON
    
    {
      "integrations": {
        "cleanspeak": {
          "apiKey": "97f3d194-ef95-480a-9ee4-eea7dbdc450a",
          "enabled": true,
          "url": "http://localhost:8001",
          "usernameModeration": {
            "applicationId": "27a7e845-79ec-4b24-a36d-66a224055395",
            "enabled": true
          }
        },
        "kafka": {
          "defaultTopic": "FusionAuth",
          "enabled": true,
          "producer": {
            "request.timeout.ms": "2000",
            "bootstrap.servers": "localhost:9092",
            "max.block.ms": "5000"
          }
        },
        "twilio": {
          "accountSID": "_superSecreteAccountSID",
          "authToken": "_superSecretAuthToken",
          "enabled": true,
          "fromPhoneNumber": "555-555-5555",
          "url": "https://api.twilio.com"
        }
      }
    }

    Update Integrations

    This API is used to update an existing Integration.

    No Id is required to update this object.

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

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

    Request

    Update Integrations

    URI

    PUT /api/integration

    PATCH /api/integration

    Available since 1.39.0

    When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

    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 Body

    integration.cleanSpeakConfiguration.apiKey [String] Optional

    The API key that is used when calling CleanSpeak for moderation.

    integration.cleanSpeakConfiguration.enabled [Boolean] Optional defaults to false

    True if CleanSpeak integration is enabled.

    integration.cleanSpeakConfiguration.url [String] Optional

    The URL of the CleanSpeak WebService service (i.e. http://localhost:8001/). Required when the CleanSpeak integration is enabled.

    integration.cleanSpeakConfiguration.usernameModeration.applicationId [UUID] Optional

    The Id of the CleanSpeak Application where usernames are sent for moderation.

    integration.cleanSpeakConfiguration.usernameModeration.enabled [Boolean] Optional defaults to false

    True if CleanSpeak username moderation is enabled.

    integration.kafka.defaultTopic [String] Optional

    The name of the Kafka topic to send messages. Required when the Kafka integration is enabled.

    integration.kafka.enabled [Boolean] Optional defaults to false

    True if the Kafka integration is enabled.

    integration.kafka.producer [Map<String, String>] Optional

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

    integration.twilio.accountSID [String] Optional Deprecated

    The Twilio Account ID to use when connecting to the Twilio API. This can be found in your Twilio dashboard. Required when the Twilio integration is enabled.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.authToken [String] Optional Deprecated

    The Twilio Auth Token to use when connecting to the Twilio API. This can be found in your Twilio dashboard. Required when the Twilio integration is enabled.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.enabled [Boolean] Optional defaults to false Deprecated

    True if the Twilio integration is enabled.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.fromPhoneNumber [String] Optional Deprecated

    The configured Twilio phone number that will be used to send messages. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.messagingServiceSid [String] Optional Deprecated

    The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers. This can be found in your Twilio dashboard.

    When using the Twilio Messaging Services Id, you may omit the fromPhoneNumber field.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    Example Request JSON
    
    {
      "integrations": {
        "cleanspeak": {
          "apiKey": "97f3d194-ef95-480a-9ee4-eea7dbdc450a",
          "enabled": true,
          "url": "http://localhost:8001",
          "usernameModeration": {
            "applicationId": "27a7e845-79ec-4b24-a36d-66a224055395",
            "enabled": true
          }
        },
        "kafka": {
          "defaultTopic": "FusionAuth",
          "enabled": true,
          "producer": {
            "request.timeout.ms": "2000",
            "bootstrap.servers": "localhost:9092",
            "max.block.ms": "5000"
          }
        },
        "twilio": {
          "accountSID": "_superSecreteAccountSID",
          "authToken": "_superSecretAuthToken",
          "enabled": true,
          "fromPhoneNumber": "555-555-5555",
          "url": "https://api.twilio.com"
        }
      }
    }

    Response

    The response for this API contains Integrations.

    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.

    500

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

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Response Body

    integration.cleanspeak.apiKey [String]

    The API key that is used when calling CleanSpeak for moderation.

    integration.cleanspeak.enabled [Boolean]

    True if CleanSpeak integration is enabled.

    integration.cleanspeak.url [String]

    The URL of the CleanSpeak WebService service (i.e. http://localhost:8001/).

    integration.cleanspeak.usernameModeration.applicationId [UUID]

    The Id of the CleanSpeak Application where usernames are sent for moderation.

    integration.cleanspeak.usernameModeration.enabled [Boolean]

    True if CleanSpeak username moderation is enabled.

    integration.kafka.defaultTopic [String]

    The name of the Kafka topic to send messages.

    integration.kafka.enabled [Boolean]

    True if the Kafka integration is enabled.

    integration.kafka.producer [Map<String, String>]

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

    integration.twilio.accountSID [String] Deprecated

    The Twilio Account ID to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.authToken [String] Deprecated

    The Twilio Auth Token to use when connecting to the Twilio API. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.enabled [Boolean] Deprecated

    True if the Twilio integration is enabled.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.fromPhoneNumber [String] Deprecated

    The configured Twilio phone number that will be used to send messages. This can be found in your Twilio dashboard.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    integration.twilio.messagingServiceSid [String] Deprecated

    The Twilio message service Id, this is used when using Twilio Copilot to load balance between numbers. This can be found in your Twilio dashboard.

    When using the Twilio Messaging Services Id, you may omit the fromPhoneNumber field.

    Removed in version 1.26.0 In version 1.26.0 and beyond, Twilio configuration can be managed in the Messengers API.

    Example Response JSON
    
    {
      "integrations": {
        "cleanspeak": {
          "apiKey": "97f3d194-ef95-480a-9ee4-eea7dbdc450a",
          "enabled": true,
          "url": "http://localhost:8001",
          "usernameModeration": {
            "applicationId": "27a7e845-79ec-4b24-a36d-66a224055395",
            "enabled": true
          }
        },
        "kafka": {
          "defaultTopic": "FusionAuth",
          "enabled": true,
          "producer": {
            "request.timeout.ms": "2000",
            "bootstrap.servers": "localhost:9092",
            "max.block.ms": "5000"
          }
        },
        "twilio": {
          "accountSID": "_superSecreteAccountSID",
          "authToken": "_superSecretAuthToken",
          "enabled": true,
          "fromPhoneNumber": "555-555-5555",
          "url": "https://api.twilio.com"
        }
      }
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates