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
      • Overview
      • Java Spring
      • Python Django
  • 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
        • Okta
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
        • Okta
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
      • URL Validation
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • PagerDuty
      • Tableau Cloud
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • Amazon API Gateway
      • Kong Gateway
      • 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
      • Application Specific Email Templates
      • 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
      • Self-Service Registration
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
      • Kickstart Custom Theme
  • 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

    User Action Reason APIs

    Overview

    This page contains the APIs that are used to manage user action reasons. Here are the APIs:

    • Create a User Action Reason

    • Retrieve a User Action Reason

    • Update a User Action Reason

    • Delete a User Action Reason

    Create a User Action Reason

    This API is used to create an User Action Reason. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the User Action Reason. Otherwise, FusionAuth will generate an Id for the User Action Reason.

    Request

    Create a User Action Reason with a generated Id

    URI

    POST /api/user-action-reason

    Create a User Action Reason with the given Id

    URI

    POST /api/user-action-reason/{userActionReasonId}

    Request Parameters

    userActionReasonId [UUID] Optional defaults to secure random UUID

    The Id to use for the new User Action Reason. If not specified a secure random UUID will be generated.

    Request Body

    userActionReason.code [String] Required

    A short code for the User Action Reason.

    userActionReason.localizedTexts [Map<Locale, String>] Optional

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReason.text [String] Required

    The text of the User Action Reason.

    Example Request JSON
    
    {
      "userActionReason": {
        "code": "VTOS",
        "localizedTexts": {
          "fr": "Violation de nos Conditions générales d'utilisation"
        },
        "text": "Violation of our Terms of Service"
      }
    }

    Response

    The response for this API contains the information for the User Action Reason that was created.

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

    userActionReason.code [String]

    A short code for the User Action Reason.

    userActionReason.id [UUID]

    The Id of the User Action Reason.

    userActionReason.localizedTexts [Map<Locale, String>]

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReason.text [String]

    The text of the User Action Reason.

    Example Response JSON for a Single User Action Reason
    
    {
      "userActionReason": {
        "code": "VTOS",
        "id": "00000000-0000-0000-0000-000000000002",
        "localizedTexts": {
          "fr": "Violation de nos Conditions générales d'utilisation"
        },
        "text": "Violation of our Terms of Service"
      }
    }

    Retrieve a User Action Reason

    This API is used to retrieve one or all of the configured User Action Reasons. Specifying an Id on the URI will retrieve a single User Action Reason. Leaving off the Id will retrieve all of the User Action Reasons.

    Request

    Retrieve all of the User Action Reasons

    URI

    GET /api/user-action-reason

    Retrieve a User Action Reason by Id

    URI

    GET /api/user-action-reason/{userActionReasonId}

    Request Parameters

    userActionReasonId [UUID] Optional

    The Id of the User Action Reason to retrieve.

    Response

    The response for this API contains either a single User Action Reason or all of the User Action Reasons. When you call this API with an Id the response will contain just that User Action Reason. When you call this API without an Id the response will contain all of the User Action Reasons. Both response types are defined below along with an example JSON response.

    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.

    404

    The object you requested doesn’t exist. The response will be empty.

    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

    userActionReason.code [String]

    A short code for the User Action Reason.

    userActionReason.id [UUID]

    The Id of the User Action Reason.

    userActionReason.localizedTexts [Map<Locale, String>]

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReason.text [String]

    The text of the User Action Reason.

    Example Response JSON for a Single User Action Reason
    
    {
      "userActionReason": {
        "code": "VTOS",
        "id": "00000000-0000-0000-0000-000000000002",
        "localizedTexts": {
          "fr": "Violation de nos Conditions générales d'utilisation"
        },
        "text": "Violation of our Terms of Service"
      }
    }

    Response Body

    userActionReasons [Array]

    The list of User Action Reason objects.

    userActionReasons[x].code [String]

    A short code for the User Action Reason.

    userActionReasons[x].id [UUID]

    The Id of the User Action Reason.

    userActionReasons[x].localizedTexts [Map<Locale, String>]

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReasons[x].text [String]

    The text of the User Action Reason.

    Example Response JSON for all the User Action Reasons
    
    {
      "userActionReasons": [
        {
          "code": "VTOS",
          "id": "00000000-0000-0000-0000-000000000002",
          "localizedTexts": {
            "fr": "Violation de nos Conditions générales d'utilisation"
          },
          "text": "Violation of our Terms of Service"
        }
      ]
    }

    Update a User Action Reason

    This API is used to update an existing User Action Reason.

    You must specify the Id of the User Action Reason you are updating on the URI.

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

    Utilize the PATCH HTTP method to send specific changes to merge into an existing User Action Reason.

    Request

    Update the User Action Reason by Id

    URI

    PUT /api/user-action-reason/{userActionReasonId}

    PATCH /api/user-action-reason/{userActionReasonId}

    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 Parameters

    userActionReasonId [UUID] Required

    The Id of the User Action Reason to update.

    Request Body

    userActionReason.code [String] Required

    A short code for the User Action Reason.

    userActionReason.localizedTexts [Map<Locale, String>] Optional

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReason.text [String] Required

    The text of the User Action Reason.

    Example Request JSON
    
    {
      "userActionReason": {
        "code": "VTOS",
        "localizedTexts": {
          "fr": "Violation de nos Conditions générales d'utilisation"
        },
        "text": "Violation of our Terms of Service"
      }
    }

    Response

    The response for this API contains the new information for the User Action Reason that was updated.

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

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    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

    userActionReason.code [String]

    A short code for the User Action Reason.

    userActionReason.id [UUID]

    The Id of the User Action Reason.

    userActionReason.localizedTexts [Map<Locale, String>]

    A mapping of localized text for the User Action Reason. The key is the Locale and the value is the localized text.

    userActionReason.text [String]

    The text of the User Action Reason.

    Example Response JSON for a Single User Action Reason
    
    {
      "userActionReason": {
        "code": "VTOS",
        "id": "00000000-0000-0000-0000-000000000002",
        "localizedTexts": {
          "fr": "Violation de nos Conditions générales d'utilisation"
        },
        "text": "Violation of our Terms of Service"
      }
    }

    Delete a User Action Reason

    This API is used to delete an User Action Reason. You must specify the Id of the User Action Reason on the URI.

    Request

    Delete a User Action Reason by Id

    URI

    DELETE /api/user-action-reason/{userActionReasonId}

    Request Parameters

    userActionReasonId [UUID] Required

    The Id of the User Action Reason to delete.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    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.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    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.

    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
    How-to
    Subscribe for developer updates