Integration API

Edit on GitHubEdit MD

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.

caution

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

Retrieve Integrations#

This API is used to retrieve integrations.

Request#

Retrieve Integrations

GET/api/integration

OpenAPI Spec

Response#

The response for this API contains the Integrations.

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 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 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 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 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 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.

You must specify the Id of the Integration you are updating on the URI. 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

PUT/api/integration

OpenAPI Spec

PATCH/api/integration

OpenAPI Spec

note

For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:

JSON Patch/RFC 6902: application/json-patch+json
JSON Merge Patch/RFC 7396: merge-patch+json

For details, see the PATCH documentation.

Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.

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 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 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 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 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 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.

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 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 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 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 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 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"
    }
  }
}