Reactor API
On this page
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#
Activate a Reactor license by sending the license key, plus the Base64-encoded license value for air-gapped deployments.
OpenAPI Spec
Request Body#
licenseIdThe license key to activate.
licenseThe 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#
Retrieve the metrics of Reactor features.
OpenAPI Spec
Response#
| Code | Description |
|---|---|
| 200 | The request succeeded. The response contains a JSON body. |
| 401 | The request has no valid Authorization header. The header is missing, or the API key isn't valid. The response is empty. For more information, see Authentication. |
| 500 | FusionAuth had an internal error and logged a stack trace in the FusionAuth log files. The response is empty. |
Response Body#
metrics.breachedPasswordMetrics The breached password metrics. The map key is the Tenant Id.
metrics.breachedPasswordMetrics[tenantId].actionRequired The total number of user accounts where action is required.
metrics.breachedPasswordMetrics[tenantId].matchedCommonPasswordCount The total number of matched user accounts with a commonly compromised password.
metrics.breachedPasswordMetrics[tenantId].matchedExactCount The total number of matched user accounts with a compromised password exact match.
metrics.breachedPasswordMetrics[tenantId].matchedPasswordCount The total number of user accounts with matched passwords.
metrics.breachedPasswordMetrics[tenantId].matchedSubAddressCount The total number of sub-email user accounts that match a compromised password.
metrics.breachedPasswordMetrics[tenantId].passwordsCheckedCount The total number of user account passwords checked.
{
"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#
Retrieve the status of Reactor features.
OpenAPI Spec
Response#
| Code | Description |
|---|---|
| 200 | The request succeeded. The response contains a JSON body. |
| 401 | The request has no valid Authorization header. The header is missing, or the API key isn't valid. The response is empty. For more information, see Authentication. |
| 500 | FusionAuth had an internal error and logged a stack trace in the FusionAuth log files. The response is empty. |
Response Body#
status.advancedIdentityProviders The status for Advanced Identity Providers.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedLambdas The status for Advanced lambda features such Lambda HTTP Connect.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedMultiFactorAuthentication The status for Advanced Multi-Factor Authentication.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedOAuthScopes The status for Advanced OAuth Scope features.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedOAuthScopesCustomScopes The status for creating custom OAuth scopes.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedOAuthScopesThirdPartyApplications The status for configuring Applications as third-party to enable OAuth scope consent prompts.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.advancedRegistration The status for Advanced Registration Forms.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.applicationMultiFactorAuthentication The status for Application scoped Multi-Factor authentication configuration.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.applicationThemes The status for Application Themes.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.breachedPasswordDetection The status for Breached Password Detection, with the following possible values:
ACTIVE- the feature is activeDISCONNECTED- the feature is currently disconnectedPENDING- the feature is pending while waiting to complete key exchange with ReactorUNKNOWN- the status of the feature is unknown
status.cimd The status for Client ID Metadata Documents (CIMD).
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.connectors The status for Connectors.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.dPoP The status for Demonstrating Proof-of-Possession (DPoP).
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.entityManagement The status for Entity Management.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.expiration 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 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 activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.licenseAttributes 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 Whether or not the FusionAuth Reactor has been activated with a valid license. This is synonymous with a licensed instance of FusionAuth.
status.scimServer The status for the SCIM Server features.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.threatDetection The status for the Threat Detection feature set.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.tokenExchange The status for OAuth Token Exchange.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.webAuthn The status for WebAuthn features.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.webAuthnPlatformAuthenticators The status for WebAuthn platform authenticators.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
status.webAuthnRoamingAuthenticators The status for WebAuthn roaming, or cross-platform, authenticators.
The possible following values:
ACTIVE- the feature is activeDISABLED- the feature is not available based upon your licenseDISCONNECTED- the feature is not currently available due to connectivity issuesPENDING- the feature is in progress of being activatedUNKNOWN- the status of the feature is unknown
{
"status": {
"advancedIdentityProviders": "ACTIVE",
"advancedLambdas": "DISABLED",
"advancedMultiFactorAuthentication": "ACTIVE",
"advancedRegistration": "ACTIVE",
"applicationMultiFactorAuthentication": "ACTIVE",
"applicationThemes": "ACTIVE",
"breachedPasswordDetection": "PENDING",
"cimd": "ACTIVE",
"connectors": "ACTIVE",
"entityManagement": "ACTIVE",
"licenseAttributes": {
"LicenseType": "Production",
"LicensedPlan": "Enterprise"
},
"licensed": true,
"scimServer": "ACTIVE",
"threatDetection": "ACTIVE",
"tokenExchange": "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#
Regenerate the Reactor license.
OpenAPI Spec
Response#
This API does not return a JSON response body.
| Code | Description |
|---|---|
| 200 | The request was successful. The response will be empty. |
| 400 | The request was invalid or malformed. The response contains an Errors JSON object with the specific errors. FusionAuth also returns a 400 when the request needs a paid FusionAuth license and no license is present. |
| 401 | The request has no valid Authorization header. The header is missing, or the API key isn't valid. The response is empty. For more information, see Authentication. |
| 404 | The object you're updating doesn't exist. The response is empty. |
| 500 | FusionAuth had an internal error and logged a stack trace in the FusionAuth log files. The response is 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#
Deactivate the Reactor license.
OpenAPI Spec
Response#
This API does not return a JSON response body.
| Code | Description |
|---|---|
| 200 | The request was successful. The response will be empty. |
| 400 | The request was invalid or malformed. The response contains an Errors JSON object with the specific errors. FusionAuth also returns a 400 when the request needs a paid FusionAuth license and no license is present. |
| 401 | The request has no valid Authorization header. The header is missing, or the API key isn't valid. The response is empty. For more information, see Authentication. |
| 404 | The object you requested doesn't exist. The response is empty. |
| 500 | FusionAuth had an internal error and logged a stack trace in the FusionAuth log files. The response is empty. |
Related
Learn about the APIs for invoking a User Action on a User.
API documentation for the FusionAuth Create an API Key API.
API documentation for the FusionAuth Delete an API Key API.
Learn about the APIs for creating, retrieving, updating and deleting API Keys.