How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FusionAuth User Action API

The User Action API from FusionAuth — 2 operation(s) for user action.

FusionAuth User Action API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Action. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

7 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth User Action API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 2 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Action 7
POST
/api/user-action
Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.
createUserAction 1 param body → 200default
GET
/api/user-action
Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions. OR Retrieves all the user actions that are currently inactive.
retrieveUserAction 2 params → 200default
POST
/api/user-action/{userActionId}
Creates a user action. This action cannot be taken on a user until this call successfully returns. Anytime after that the user action can be applied to any user.
createUserActionWithId 2 params body → 200default
DELETE
/api/user-action/{userActionId}
Deletes the user action for the given Id. This permanently deletes the user action and also any history and logs of the action being applied to any users. OR Deactivates the user action with the give…
deleteUserActionWithId 3 params → 200default
PATCH
/api/user-action/{userActionId}
Updates, via PATCH, the user action with the given Id.
patchUserActionWithId 2 params body → 200default
PUT
/api/user-action/{userActionId}
Updates the user action with the given Id. OR Reactivates the user action with the given Id.
updateUserActionWithId 3 params body → 200default
GET
/api/user-action/{userActionId}
Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user actions.
retrieveUserActionWithId 2 params → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserAction (18 properties), Error (3 properties), Errors (2 properties), UserActionOption (2 properties). Each schema is shown below with its type and property counts.

TransactionType
string
The transaction types for Webhooks and other event systems within FusionAuth.
UserActionOption
object
Models content user action options.
2 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
LocalizedStrings
object
Models a set of localized Strings that can be stored as JSON.
UserActionResponse
object
User Action API response object.
2 properties
UserAction
object
An action that can be executed on a user (discipline or reward potentially).
18 properties
Error
object
Defines an error.
3 properties
UserActionRequest
object
User Action API request object.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-user-action-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Email API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
Where this information came from

This is an independent, third-party profile of FusionAuth User Action API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.