Reactor API

Edit on GitHubView Markdown
On this page
Available since 1.26.0

This page contains the APIs for Reactor, FusionAuth's license system. Reactor is used to activate features based upon your licensing tier. Here are the APIs:

Activate Reactor License#

This API is used to activate a Reactor license.

Request#

Global API Key Authentication
Activate a Reactor license
POST/api/reactor
OpenAPI Spec

Request Body#

licenseId
  • Type: String
  • Required

The license Id to activate.

license
  • Type: String
  • Optional

The Base64-encoded license value. This value is necessary in an air-gapped configuration where outbound network access is not available.

Response#

This API does not return a JSON response body.

Response Codes

Code Description
200 The request was successful.
400 The request was invalid or malformed, or this feature requires a paid FusionAuth license that is not present. The response will contain an Errors JSON object with the specific errors.
401 The request did not supply a valid Authorization header (typically omitted or an invalid API key). The response will be empty. See Authentication.
409 This instance is already licensed. To change the license, you must first DELETE the existing license.
500 There was an internal error. The response will be empty. To find the related stack trace, check the log files for your FusionAuth instance.

Retrieve Reactor Metrics#

This API is used to retrieve the metrics of Reactor features.

Request#

Global API Key Authentication
Retrieve Reactor metrics
GET/api/reactor/metrics
OpenAPI Spec

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
401You 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.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

metrics.breachedPasswordMetrics
  • Type: Map<UUID, List<Object>

The breached password metrics. The map key is the Tenant Id.

metrics.breachedPasswordMetrics[tenantId].actionRequired
  • Type: Integer

The total number of user accounts where action is required.

metrics.breachedPasswordMetrics[tenantId].matchedCommonPasswordCount
  • Type: Integer

The total number of matched user accounts with a commonly compromised password.

metrics.breachedPasswordMetrics[tenantId].matchedExactCount
  • Type: Integer

The total number of matched user accounts with a compromised password exact match.

metrics.breachedPasswordMetrics[tenantId].matchedPasswordCount
  • Type: Integer

The total number of user accounts with matched passwords.

metrics.breachedPasswordMetrics[tenantId].matchedSubAddressCount
  • Type: Integer

The total number of sub-email user accounts that match a compromised password.

metrics.breachedPasswordMetrics[tenantId].passwordsCheckedCount
  • Type: Integer

The total number of user account passwords checked.

Example Response JSON
{
  "metrics": {
    "breachedPasswordMetrics": {
      "30663132-6464-6665-3032-326466613934": {
        "actionRequired": 6,
        "matchedCommonPasswordCount": 2,
        "matchedExactCount": 3,
        "matchedPasswordCount": 3,
        "matchedSubAddressCount": 1,
        "passwordsCheckedCount": 23
      }
    }
  }
}

Retrieve Reactor Status#

This API is used to retrieve the status of Reactor features.

Request#

Global API Key Authentication
Retrieve Reactor status
GET/api/reactor
OpenAPI Spec

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
401You 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.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

status.advancedIdentityProviders
  • Type: String

The status for Advanced Identity Providers.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedLambdas
  • Type: String
  • Available since 1.35.0

The status for Advanced lambda features such Lambda HTTP Connect.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedMultiFactorAuthentication
  • Type: String

The status for Advanced Multi-Factor Authentication.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedOAuthScopes
  • Type: String
  • Available since 1.50.0

The status for Advanced OAuth Scope features.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedOAuthScopesCustomScopes
  • Type: String
  • Available since 1.50.0

The status for creating custom OAuth scopes.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedOAuthScopesThirdPartyApplications
  • Type: String
  • Available since 1.50.0

The status for configuring Applications as third-party to enable OAuth scope consent prompts.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.advancedRegistration
  • Type: String

The status for Advanced Registration Forms.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.applicationMultiFactorAuthentication
  • Type: String
  • Available since 1.37.0

The status for Application scoped Multi-Factor authentication configuration.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.applicationThemes
  • Type: String

The status for Application Themes.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.breachedPasswordDetection
  • Type: String

The status for Breached Password Detection. The possible following values:

  • ACTIVE - the feature is active
  • DISCONNECTED - the feature is currently disconnected
  • PENDING - the feature is pending while waiting to complete key exchange with Reactor
  • UNKNOWN - the status of the feature is unknown
status.connectors
  • Type: String

The status for Connectors.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.dPoP
  • Type: String
  • Available since 1.63.0

The status for Demonstrating Proof-of-Possession (DPoP).

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.entityManagement
  • Type: String

The status for Entity Management.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.expiration
  • Type: String
  • Available since 1.36.0

If the license is configured to be air-gapped, this value will be returned to indicate the license expiration. An air-gapped license is one that does not require egress network connectivity to the FusionAuth license server. If the license is not configured to be air-gapped, then this field will not be returned in the response.

The expiration string is formatted as an ISO-8601 string in the form YYYY-MM-DD.

status.ipGeoLocation
  • Type: String
  • Available since 1.64.0

The status for the IP Geolocation feature set. Prior to version 1.64.0, this feature set was included in the status.threatDetection field.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.licenseAttributes
  • Type: Map<String, String>
  • Available since 1.37.0

A set of attributes describing the license, this is primarily used for internal use and may help describe the license. The values returned in this object are subject to change.

status.licensed
  • Type: Boolean

Whether or not the FusionAuth Reactor has been activated with a valid license. This is synonymous with a licensed instance of FusionAuth.

status.scimServer
  • Type: String
  • Available since 1.36.0

The status for the SCIM Server features.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.threatDetection
  • Type: String
  • Available since 1.30.0

The status for the Threat Detection feature set.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.webAuthn
  • Type: String
  • Available since 1.41.0

The status for WebAuthn features.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.webAuthnPlatformAuthenticators
  • Type: String
  • Available since 1.41.0

The status for WebAuthn platform authenticators.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
status.webAuthnRoamingAuthenticators
  • Type: String
  • Available since 1.41.0

The status for WebAuthn roaming, or cross-platform, authenticators.

The possible following values:

  • ACTIVE - the feature is active
  • DISABLED - the feature is not available based upon your license
  • DISCONNECTED - the feature is not currently available due to connectivity issues
  • PENDING - the feature is in progress of being activated
  • UNKNOWN - the status of the feature is unknown
Example Response JSON
{
  "status": {
    "advancedIdentityProviders": "ACTIVE",
    "advancedLambdas": "DISABLED",
    "advancedMultiFactorAuthentication": "ACTIVE",
    "advancedRegistration": "ACTIVE",
    "applicationMultiFactorAuthentication": "ACTIVE",
    "applicationThemes": "ACTIVE",
    "breachedPasswordDetection": "PENDING",
    "connectors": "ACTIVE",
    "entityManagement": "ACTIVE",
    "licenseAttributes": {
      "LicenseType": "Production",
      "LicensedPlan": "Enterprise"
    },
    "licensed": true,
    "scimServer": "ACTIVE",
    "threatDetection": "ACTIVE",
    "webAuthn": "ACTIVE",
    "webAuthnPlatformAuthenticators": "ACTIVE",
    "webAuthnRoamingAuthenticators": "ACTIVE"
  }
}

Regenerate Reactor License#

This API is used to make requests from FusionAuth to the License server to regenerate a license. This is particularly useful if it is suspected that the license key has been compromised and a new one is needed.

Regenerating the license will cause any other instance using the license to revert to Community plan features. All configuration will be maintained, but any paid plan functionality will be disabled. The instance of FusionAuth that makes this API request will be updated to use the new license key, but each additional instance requiring a license will need the updated license key.

Request#

Global API Key Authentication
Regenerate a Reactor license
PUT/api/reactor
OpenAPI Spec

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful. The response will be empty.
400The 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.
401You 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.
404The object you are trying to update doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Deactivate Reactor License#

This API is used to deactivate a Reactor license. If Breached Password Detection was being used it will no longer work, licensed features can no longer be enabled, and existing configurations may no longer work if they use licensed features.

Request#

Global API Key Authentication
Deactivate Reactor license
DELETE/api/reactor
OpenAPI Spec

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful. The response will be empty.
400The 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.
401You 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.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Related

APIs

User Action API

Learn about the APIs for invoking a User Action on a User.

fusionauth apirest apihttp api
APIs

Create an API Key API

API documentation for the FusionAuth Create an API Key API.

fusionauth apirest apihttp api
APIs

Delete an API Key API

API documentation for the FusionAuth Delete an API Key API.

fusionauth apirest apihttp api
APIs

API Keys API

Learn about the APIs for creating, retrieving, updating and deleting API Keys.

fusionauth apirest apihttp api