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
  • 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
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • 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
      • 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
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • 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

    Login APIs

    Overview

    The following APIs are used to authenticate and track user logins.

    • Authenticate a User

    • Authenticate a User with a one time password

    • Complete Multi-Factor Authentication

    • Update Login Instant

    • Logout a User

    The following APIs allow you to search and export historical login records.

    • Search Login Records

    • Export Login Records

    Authenticate a User

    The Login API is used authenticate a user in FusionAuth. The issuer of the One Time Password will dictate if a JWT or a Refresh Token may be issued in the API response.

    Request

    By default, this API will require API key authentication when called with an applicationId. API key authentication may be disabled per Application, see application.loginConfiguration.requireAuthentication in the Application API or navigate to Applications → Edit → Security in the user interface.

    Prior to version 1.5.0 this API did not accept an API key and never required authentication.

    Authenticate a User

    URI

    POST /api/login

    Request Headers

    X-Forwarded-For [String] Optional

    The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available, the request body value will take precedence.

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Cookies

    fusionauth.trust [String] Optional

    The Multi-Factor Trust identifier returned by the Multi-Factor Login API response. This value may be provided to bypass the Multi-Factor challenge when a User has Multi-Factor enabled. When this cookie exists on the request it will take precedence over the twoFactorTrustId if provided in the request body.

    Request Body

    applicationId [UUID] Optional

    The Id of the Application the user is to be logged into. This parameter is optional but there is not likely a production use case where you want to omit the value. If this parameter is omitted the user will still be authenticated but a login count will not be recorded for an Application.

    Because a refresh token is per user and per application, when this parameter is not provided a refresh token will not be returned.

    You likely want the user being logged in to be registered for this application. If that user isn’t, the call will succeed, the response body will be different, no refresh token will be issued, and you’ll receive a 202 HTTP status.

    See the difference between authentication and authorization for more detail.

    ipAddress [String] Optional

    The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

    loginId [String] Required

    The login identifier of the user. The login identifier can be either the email or the username.

    metaData.device.description [String] Optional

    A human readable description of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.name [String] Optional

    A human readable name of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.type [String] Optional

    The type of device used. The following types may be specified:

    • BROWSER

    • DESKTOP

    • LAPTOP

    • MOBILE

    • OTHER

    • SERVER

    • TABLET

    • TV

    • UNKNOWN

    This meta data is used to describe the refresh token that may be generated for this request.

    noJWT [Boolean] Optional defaults to false

    When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token or refreshToken fields, and the access_token and refresh_token cookies will not be written to the HTTP response.

    This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being utilized, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.

    password [String] Required

    The user’s password or an Application specific Authentication Token.

    twoFactorTrustId [String] Optional

    The Multi-Factor Trust identifier returned by the Multi-Factor Login API response. This value may be provided to bypass the Multi-Factor challenge when a User has Multi-Factor enabled.

    Example Request JSON
    
    {
      "loginId": "example@fusionauth.io",
      "password": "password",
      "applicationId": "10000000-0000-0002-0000-000000000001",
      "noJWT" : false,
      "ipAddress": "192.168.1.42"
    }

    Response

    The response for this API contains the User object.

    Table 1. Response Codes
    Code Description

    200

    The authentication was successful. The response will contain the User object that was authenticated.

    202

    The user was authenticated successfully. The user is not registered for the application specified by the applicationId on the request. The response will contain the User object that was authenticated.

    203

    The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API. Since version 1.15.0, the response will also contain a changePasswordReason field which can have one of the following values:

    • Administrative - An administrator has required this user to change their password.

    • Breached - The password has been found to have belonged to a breached dataset and must be changed, per the Reactor configuration.

    • Expired - The password has expired, per the expiration setting in the tenant configuration.

    • Validation - The password fails the validation rules configured in the tenant password settings.

    Example Response JSON
    
      {
      "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ",
      "changePasswordReason": "Expired"
    }

    212

    The user’s email address has not yet been verified. The response will contain the User object that was authenticated. If the emailConfiguration.verificationStrategy has been set to FormField, the response will contain the emailVerificationId that was generated for the user.

    213

    The user’s registration has not yet been verified. The response will contain the User object that was authenticated. If the emailConfiguration.verificationStrategy has been set to FormField, the response will contain the registrationVerificationId that was generated for the user.

    Prior to version 1.27.0, this status code was not returned, and you will see a 200 instead.

    242

    The user was authenticated successfully. The user has two factor authentication enabled, the response will contain the twoFactorId to be used on the Complete Two Factor Authentication API.

    Example Response JSON
    
      {
      "methods": [
        {
          "authenticator": {
            "algorithm": "HmacSHA1",
            "codeLength": 6,
            "timeStep": 30
          },
          "id": "2KSZ",
          "method": "authenticator"
        },
        {
          "email": "richard@fusionauth.io",
          "id": "KLRT",
          "method": "email"
        }
      ],
      "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
    }

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

    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.

    By default, this API will require authentication.

    Authentication may be disabled per Application, see application.loginConfiguration.requireAuthentication in the Application API or the Security tab in the Application configuration. Prior to version 1.5.0 this API never require an API key. If you are not sending an applicationId then this settings is configured at the tenant level, see tenant.loginConfiguration.requireAuthentication on the Tenant API or the Security tab in the Tenant configuration.

    404

    The user was not found or the password was incorrect. The response will be empty.

    409

    The user is currently in an action that has prevented login. The response will contain the actions that prevented login.

    Example Response JSON
    
      {
      "actions": [
        {
          "actionId": "00000000-0000-0000-0000-000000000042",
          "actionerUserId": "00000000-0000-0001-0000-000000000000",
          "expiry": 1571786483322,
          "localizedName": "Prevent Login Action",
          "localizedReason": "Hard Lock",
          "name": "Prevent Login Action",
          "reason": "Hard Lock",
          "reasonCode": "hard_lock"
        }
      ]
    }

    410

    The user has expired. The response will be empty.

    423

    The user is locked and cannot login. The response will be empty.

    Prior to version 1.9.0 a 404 status code will be returned instead.

    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

    refreshToken [String]

    The refresh token that can be used to obtain a new access token once the provided one has expired.

    Because a refresh token is per user and per application, this value will only be returned when an applicationId was provided on the login request and the user is registered to the application.

    You must explicitly allow generation of refresh tokens when using the Login API. Configure the application.loginConfiguration.generateRefreshTokens setting via the API or enable the setting by navigating to the Application → My Application → Security tab.

    refreshTokenId [String] Available since 1.37.0

    When the refreshToken is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the Refresh Token API.

    state [Object]

    If authenticated using a One Time Password and state was provided during the Change Password request this value will be returned exactly as it was provided.

    token [String] Available since 1.16.0

    The access token, this string is an encoded JSON Web Token (JWT).

    tokenExpirationInstant [Long] Available since 1.33.0

    The instant the token will expire. If the response does not contain a token, this field will also be omitted from the response.

    user.active [Boolean]

    True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.

    user.birthDate [String]

    The User’s birthdate formatted as YYYY-MM-DD

    user.breachedPasswordLastCheckedInstant [Long]

    The instant this user’s password was last checked to determine if it is compromised.

    user.connectorId [UUID] Available since 1.18.0

    The unique Id of the Connector associated with the System of Record being used to authenticate the user.

    user.cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.data [Object]

    An object that can hold any information about the User that should be persisted.

    user.data.email [String]

    This field will be used as the email address if no user.email field is found.

    This feature was removed in version 1.26.0 and added back in in 1.27.2.

    user.email [String]

    The User’s email address.

    user.expiry [Long]

    The expiration instant of the User’s account. An expired user is not permitted to login.

    user.firstName [String]

    The first name of the User.

    user.fullName [String]

    The User’s full name as a separate field that is not calculated from firstName and lastName.

    user.id [UUID]

    The User’s unique Id.

    user.imageUrl [String]

    The URL that points to an image file that is the User’s profile image.

    user.insertInstant [Long]

    The instant when the user was created.

    user.lastLoginInstant [Long]

    The instant when the User logged in last.

    user.lastName [String]

    The User’s last name.

    user.lastUpdateInstant [Long]

    The instant when the User was last updated.

    user.memberships [Array]

    The list of memberships for the User.

    user.memberships[x].data [Object]

    An object that can hold any information about the User for this membership that should be persisted.

    user.memberships[x].groupId [UUID]

    The Id of the Group of this membership.

    user.memberships[x].id [UUID]

    The unique Id of this membership.

    user.memberships[x].insertInstant [Long]

    The instant that the membership was created.

    user.middleName [String]

    The User’s middle name.

    user.mobilePhone [String]

    The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.

    user.parentEmail [String] Available since 1.7.0

    The email address of the user’s parent or guardian. If this value was provided during a create or update operation, this value will only remain until the child is claimed by a parent.

    user.passwordChangeRequired [Boolean]

    Indicates that the User’s password needs to be changed during their next login attempt.

    user.passwordLastUpdateInstant [Long]

    The instant that the User last changed their password.

    user.preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text. See Locales.

    user.registrations [Array]

    The list of registrations for the User. This will include registrations for inactive applications.

    user.registrations[x].applicationId [UUID]

    The Id of the Application that this registration is for.

    user.registrations[x].authenticationToken [String]

    The Authentication Token for this registration (if one exists).

    user.registrations[x].cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.registrations[x].data [Object]

    An object that can hold any information about the User for this registration that should be persisted.

    user.registrations[x].id [UUID]

    The Id of this registration.

    user.registrations[x].insertInstant [Long]

    The instant that this registration was created.

    user.registrations[x].lastLoginInstant [Long]

    The instant that the User last logged into the Application for this registration.

    user.registrations[x].preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

    user.registrations[x].roles [Array<String>]

    The list of roles that the User has for this registration.

    user.registrations[x].timezone [String]

    The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

    user.registrations[x].tokens [Map<String,String>] Deprecated

    A map that contains tokens returned from identity providers.

    For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name Facebook. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.

    Removed in 1.28.0

    The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider Link API.

    user.registrations[x].username [String]

    The username of the User for this registration only. This is for display purposes and cannot be used to login.

    user.registrations[x].usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.registrations[x].verified [Boolean]

    This value indicates if this User’s registration has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    user.tenantId [UUID]

    The Id of the Tenant that this User belongs to.

    user.timezone [String]

    The User’s preferred timezone. This can be used as a default to display instants, and it is recommended that you allow Users to change this per-session. The string will be in an IANA time zone format.

    user.twoFactor.methods[x].authenticator.algorithm [String]

    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.

    user.twoFactor.methods[x].authenticator.codeLength [Integer]

    The length of code generated by the TOTP. With the current implementation, this will always be 6.

    user.twoFactor.methods[x].authenticator.timeStep [Integer]

    The time-step size in seconds. With the current implementation, this will always be 30.

    user.twoFactor.methods[x].email [String]

    The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.

    user.twoFactor.methods[x].id [String]

    The unique Id of the method.

    user.twoFactor.methods[x].lastUsed [Boolean]

    true if this method was used most recently.

    user.twoFactor.methods[x].method [String]

    The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are:

    • authenticator

    • email

    • sms

    user.twoFactor.methods[x].mobilePhone [String]

    The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.

    user.twoFactor.methods[x].secret [String]

    A base64 encoded secret

    user.twoFactorDelivery [String] Deprecated

    The User’s preferred delivery for verification codes during a two factor login request.

    The possible values are:

    • None

    • TextMessage

      Removed in version 1.26.0

    user.twoFactorEnabled [Boolean] Deprecated

    Determines if the User has two factor authentication enabled for their account or not.

    Removed in version 1.26.0

    user.username [String]

    The username of the User.

    user.usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.verified [Boolean]

    Whether or not the User’s email has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    Example Response JSON
    
    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
      "user": {
        "active": true,
        "birthDate": "1976-05-30",
        "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
        "data": {
          "displayName": "Johnny Boy",
          "favoriteColors": [
            "Red",
            "Blue"
          ]
        },
        "email": "example@fusionauth.io",
        "expiry": 1571786483322,
        "firstName": "John",
        "fullName": "John Doe",
        "id": "00000000-0000-0001-0000-000000000000",
        "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
        "lastLoginInstant": 1471786483322,
        "lastName": "Doe",
        "middleName": "William",
        "mobilePhone": "303-555-1234",
        "passwordChangeRequired": false,
        "passwordLastUpdateInstant": 1471786483322,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "registrations": [
          {
            "applicationId": "10000000-0000-0002-0000-000000000001",
            "data": {
              "displayName": "Johnny",
              "favoriteSports": [
                "Football",
                "Basketball"
              ]
            },
            "id": "00000000-0000-0002-0000-000000000000",
            "insertInstant": 1446064706250,
            "lastLoginInstant": 1456064601291,
            "preferredLanguages": [
              "en",
              "fr"
            ],
            "roles": [
              "user",
              "community_helper"
            ],
            "username": "johnny123",
            "usernameStatus": "ACTIVE"
          }
        ],
        "timezone": "America/Denver",
        "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
        "twoFactorEnabled": false,
        "usernameStatus": "ACTIVE",
        "username": "johnny123",
        "verified": true
      }
    }

    Response Cookies

    access_token [String]

    The encoded access token. This cookie is written in the response as an HTTP Only session cookie.

    refresh_token [String]

    The refresh token. This cookie is written in the response as an HTTP only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.

    Authenticate a User with a one time password

    This API is used to login using a One Time Password that has been returned from the Change Password API. The login request is nearly identical, however the oneTimePasswordId will take the place of both the loginId and the password properties.

    Request

    By default, this API will require authentication when called with an applicationId. Authentication may be disabled per Application, see application.loginConfiguration.requireAuthentication in the Application API or navigate to Applications → Edit → Security in the user interface.

    Authenticate a User

    URI

    POST /api/login

    Request Headers

    X-Forwarded-For [String] Optional

    The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available, the request body value will take precedence.

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    applicationId [UUID] Optional

    The Id of the Application the user is to be logged into. This parameter is optional but there is not likely a production use case where you want to omit the value. If this parameter is omitted the user will still be authenticated but a login count will not be recorded for an Application.

    Because a refresh token is per user and per application, when this parameter is not provided a refresh token will not be returned.

    You likely want the user being logged in to be registered for this application. If that user isn’t, the call will succeed, the response body will be different, no refresh token will be issued, and you’ll receive a 202 HTTP status.

    See the difference between authentication and authorization for more detail.

    ipAddress [String] Optional

    The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

    oneTimePassword [String] Required

    The one time password returned by the Change Password API. This value takes the place of the loginId and the password fields.

    metaData.device.description [String] Optional

    A human readable description of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.name [String] Optional

    A human readable name of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.type [String] Optional

    The type of device used. The following types may be specified:

    • BROWSER

    • DESKTOP

    • LAPTOP

    • MOBILE

    • OTHER

    • SERVER

    • TABLET

    • TV

    • UNKNOWN

    This meta data is used to describe the refresh token that may be generated for this request.

    noJWT [Boolean] Optional defaults to false

    When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token or refreshToken fields, and the access_token and refresh_token cookies will not be written to the HTTP response.

    This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being utilized, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.

    twoFactorTrustId [String] Optional

    The Multi-Factor Trust identifier returned by the Multi-Factor Login API response. This value may be provided to bypass the Multi-Factor challenge when a User has Multi-Factor enabled.

    Example Request JSON
    
    {
      "oneTimePassword": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4",
      "applicationId": "10000000-0000-0002-0000-000000000001",
      "ipAddress": "192.168.1.42"
    }

    Response

    The response for this API contains the User object.

    Table 2. Response Codes
    Code Description

    200

    The authentication was successful. The response will contain the User object that was authenticated.

    202

    The user was authenticated successfully. The user is not registered for the application specified by the applicationId on the request. The response will contain the User object that was authenticated.

    203

    The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API. Since version 1.15.0, the response will also contain a changePasswordReason field which can have one of the following values:

    • Administrative - An administrator has required this user to change their password.

    • Breached - The password has been found to have belonged to a breached dataset and must be changed, per the Reactor configuration.

    • Expired - The password has expired, per the expiration setting in the tenant configuration.

    • Validation - The password fails the validation rules configured in the tenant password settings.

    Example Response JSON
    
      {
      "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ",
      "changePasswordReason": "Expired"
    }

    212

    The user’s email address has not yet been verified. The response will contain the User object that was authenticated. If the emailConfiguration.verificationStrategy has been set to FormField, the response will contain the emailVerificationId that was generated for the user.

    213

    The user’s registration has not yet been verified. The response will contain the User object that was authenticated. If the emailConfiguration.verificationStrategy has been set to FormField, the response will contain the registrationVerificationId that was generated for the user.

    Prior to version 1.27.0, this status code was not returned, and you will see a 200 instead.

    242

    The user was authenticated successfully. The user has two factor authentication enabled, the response will contain the twoFactorId to be used on the Complete Two Factor Authentication API.

    Example Response JSON
    
      {
      "methods": [
        {
          "authenticator": {
            "algorithm": "HmacSHA1",
            "codeLength": 6,
            "timeStep": 30
          },
          "id": "2KSZ",
          "method": "authenticator"
        },
        {
          "email": "richard@fusionauth.io",
          "id": "KLRT",
          "method": "email"
        }
      ],
      "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
    }

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

    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.

    By default, this API will require authentication.

    Authentication may be disabled per Application, see application.loginConfiguration.requireAuthentication in the Application API or the Security tab in the Application configuration. Prior to version 1.5.0 this API never require an API key. If you are not sending an applicationId then this settings is configured at the tenant level, see tenant.loginConfiguration.requireAuthentication on the Tenant API or the Security tab in the Tenant configuration.

    404

    The user was not found or the password was incorrect. The response will be empty.

    409

    The user is currently in an action that has prevented login. The response will contain the actions that prevented login.

    Example Response JSON
    
      {
      "actions": [
        {
          "actionId": "00000000-0000-0000-0000-000000000042",
          "actionerUserId": "00000000-0000-0001-0000-000000000000",
          "expiry": 1571786483322,
          "localizedName": "Prevent Login Action",
          "localizedReason": "Hard Lock",
          "name": "Prevent Login Action",
          "reason": "Hard Lock",
          "reasonCode": "hard_lock"
        }
      ]
    }

    410

    The user has expired. The response will be empty.

    423

    The user is locked and cannot login. The response will be empty.

    Prior to version 1.9.0 a 404 status code will be returned instead.

    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

    refreshToken [String]

    The refresh token that can be used to obtain a new access token once the provided one has expired.

    Because a refresh token is per user and per application, this value will only be returned when an applicationId was provided on the login request and the user is registered to the application.

    You must explicitly allow generation of refresh tokens when using the Login API. Configure the application.loginConfiguration.generateRefreshTokens setting via the API or enable the setting by navigating to the Application → My Application → Security tab.

    refreshTokenId [String] Available since 1.37.0

    When the refreshToken is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the Refresh Token API.

    state [Object]

    If authenticated using a One Time Password and state was provided during the Change Password request this value will be returned exactly as it was provided.

    token [String] Available since 1.16.0

    The access token, this string is an encoded JSON Web Token (JWT).

    tokenExpirationInstant [Long] Available since 1.33.0

    The instant the token will expire. If the response does not contain a token, this field will also be omitted from the response.

    user.active [Boolean]

    True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.

    user.birthDate [String]

    The User’s birthdate formatted as YYYY-MM-DD

    user.breachedPasswordLastCheckedInstant [Long]

    The instant this user’s password was last checked to determine if it is compromised.

    user.connectorId [UUID] Available since 1.18.0

    The unique Id of the Connector associated with the System of Record being used to authenticate the user.

    user.cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.data [Object]

    An object that can hold any information about the User that should be persisted.

    user.data.email [String]

    This field will be used as the email address if no user.email field is found.

    This feature was removed in version 1.26.0 and added back in in 1.27.2.

    user.email [String]

    The User’s email address.

    user.expiry [Long]

    The expiration instant of the User’s account. An expired user is not permitted to login.

    user.firstName [String]

    The first name of the User.

    user.fullName [String]

    The User’s full name as a separate field that is not calculated from firstName and lastName.

    user.id [UUID]

    The User’s unique Id.

    user.imageUrl [String]

    The URL that points to an image file that is the User’s profile image.

    user.insertInstant [Long]

    The instant when the user was created.

    user.lastLoginInstant [Long]

    The instant when the User logged in last.

    user.lastName [String]

    The User’s last name.

    user.lastUpdateInstant [Long]

    The instant when the User was last updated.

    user.memberships [Array]

    The list of memberships for the User.

    user.memberships[x].data [Object]

    An object that can hold any information about the User for this membership that should be persisted.

    user.memberships[x].groupId [UUID]

    The Id of the Group of this membership.

    user.memberships[x].id [UUID]

    The unique Id of this membership.

    user.memberships[x].insertInstant [Long]

    The instant that the membership was created.

    user.middleName [String]

    The User’s middle name.

    user.mobilePhone [String]

    The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.

    user.parentEmail [String] Available since 1.7.0

    The email address of the user’s parent or guardian. If this value was provided during a create or update operation, this value will only remain until the child is claimed by a parent.

    user.passwordChangeRequired [Boolean]

    Indicates that the User’s password needs to be changed during their next login attempt.

    user.passwordLastUpdateInstant [Long]

    The instant that the User last changed their password.

    user.preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text. See Locales.

    user.registrations [Array]

    The list of registrations for the User. This will include registrations for inactive applications.

    user.registrations[x].applicationId [UUID]

    The Id of the Application that this registration is for.

    user.registrations[x].authenticationToken [String]

    The Authentication Token for this registration (if one exists).

    user.registrations[x].cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.registrations[x].data [Object]

    An object that can hold any information about the User for this registration that should be persisted.

    user.registrations[x].id [UUID]

    The Id of this registration.

    user.registrations[x].insertInstant [Long]

    The instant that this registration was created.

    user.registrations[x].lastLoginInstant [Long]

    The instant that the User last logged into the Application for this registration.

    user.registrations[x].preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

    user.registrations[x].roles [Array<String>]

    The list of roles that the User has for this registration.

    user.registrations[x].timezone [String]

    The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

    user.registrations[x].tokens [Map<String,String>] Deprecated

    A map that contains tokens returned from identity providers.

    For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name Facebook. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.

    Removed in 1.28.0

    The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider Link API.

    user.registrations[x].username [String]

    The username of the User for this registration only. This is for display purposes and cannot be used to login.

    user.registrations[x].usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.registrations[x].verified [Boolean]

    This value indicates if this User’s registration has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    user.tenantId [UUID]

    The Id of the Tenant that this User belongs to.

    user.timezone [String]

    The User’s preferred timezone. This can be used as a default to display instants, and it is recommended that you allow Users to change this per-session. The string will be in an IANA time zone format.

    user.twoFactor.methods[x].authenticator.algorithm [String]

    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.

    user.twoFactor.methods[x].authenticator.codeLength [Integer]

    The length of code generated by the TOTP. With the current implementation, this will always be 6.

    user.twoFactor.methods[x].authenticator.timeStep [Integer]

    The time-step size in seconds. With the current implementation, this will always be 30.

    user.twoFactor.methods[x].email [String]

    The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.

    user.twoFactor.methods[x].id [String]

    The unique Id of the method.

    user.twoFactor.methods[x].lastUsed [Boolean]

    true if this method was used most recently.

    user.twoFactor.methods[x].method [String]

    The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are:

    • authenticator

    • email

    • sms

    user.twoFactor.methods[x].mobilePhone [String]

    The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.

    user.twoFactor.methods[x].secret [String]

    A base64 encoded secret

    user.twoFactorDelivery [String] Deprecated

    The User’s preferred delivery for verification codes during a two factor login request.

    The possible values are:

    • None

    • TextMessage

      Removed in version 1.26.0

    user.twoFactorEnabled [Boolean] Deprecated

    Determines if the User has two factor authentication enabled for their account or not.

    Removed in version 1.26.0

    user.username [String]

    The username of the User.

    user.usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.verified [Boolean]

    Whether or not the User’s email has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    Example Response JSON
    
    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
      "user": {
        "active": true,
        "birthDate": "1976-05-30",
        "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
        "data": {
          "displayName": "Johnny Boy",
          "favoriteColors": [
            "Red",
            "Blue"
          ]
        },
        "email": "example@fusionauth.io",
        "expiry": 1571786483322,
        "firstName": "John",
        "fullName": "John Doe",
        "id": "00000000-0000-0001-0000-000000000000",
        "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
        "lastLoginInstant": 1471786483322,
        "lastName": "Doe",
        "middleName": "William",
        "mobilePhone": "303-555-1234",
        "passwordChangeRequired": false,
        "passwordLastUpdateInstant": 1471786483322,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "registrations": [
          {
            "applicationId": "10000000-0000-0002-0000-000000000001",
            "data": {
              "displayName": "Johnny",
              "favoriteSports": [
                "Football",
                "Basketball"
              ]
            },
            "id": "00000000-0000-0002-0000-000000000000",
            "insertInstant": 1446064706250,
            "lastLoginInstant": 1456064601291,
            "preferredLanguages": [
              "en",
              "fr"
            ],
            "roles": [
              "user",
              "community_helper"
            ],
            "username": "johnny123",
            "usernameStatus": "ACTIVE"
          }
        ],
        "timezone": "America/Denver",
        "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
        "twoFactorEnabled": false,
        "usernameStatus": "ACTIVE",
        "username": "johnny123",
        "verified": true
      }
    }

    Response Cookies

    access_token [String]

    The encoded access token. This cookie is written in the response as an HTTP Only session cookie.

    refresh_token [String]

    The refresh token. This cookie is written in the response as an HTTP only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.

    Complete Multi-Factor Authentication

    The Multi-Factor Login API is used to complete the authentication process when a 242 status code is returned by the Login API.

    Request

    Complete a login request when a User has Multi-Factor authentication enabled.

    Complete a Multi-Factor Login

    URI

    POST /api/two-factor/login

    Request Headers

    X-Forwarded-For [String] Optional

    The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body, this header value will be used if available. If provided in both places, the request body value takes precedence.

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    applicationId [UUID] Optional

    The Id of the Application the user is to be logged into. This parameter is optional but there is not likely a production use case where you want to omit the value. If this parameter is omitted the user will still be authenticated but a login count will not be recorded for an Application.

    Because a refresh token is per user and per application, when this parameter is not provided a refresh token will not be returned.

    You likely want the user being logged in to be registered for this application. If that user isn’t, the call will succeed, the response body will be different, no refresh token will be issued, and you’ll receive a 202 HTTP status.

    See the difference between authentication and authorization for more detail.

    code [String] Required

    The Multi-Factor verification code. This may also be a recovery code.

    ipAddress [String] Optional

    The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

    metaData.device.description [String] Optional

    A human readable description of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.name [String] Optional

    A human readable name of the device used. This meta data is used to describe the refresh token that may be generated for this request.

    metaData.device.type [String] Optional

    The type of device used. The following types may be specified:

    • BROWSER

    • DESKTOP

    • LAPTOP

    • MOBILE

    • OTHER

    • SERVER

    • TABLET

    • TV

    • UNKNOWN

    This meta data is used to describe the refresh token that may be generated for this request.

    noJWT [Boolean] Optional defaults to false

    When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token field, and the access_token and refresh_token cookies will not be written to the HTTP response.

    trustComputer [Boolean] Optional defaults to false

    When this value is set to true the response will contain a Multi-Factor Trust identifier. This can be used on subsequent Login requests to allow the Multi-Factor challenge to be bypassed.

    twoFactorId [String] Required

    An Id generated and returned in the response body during the initial authentication attempt.

    The default duration of this identifier is 5 minutes. This means that you have 5 minutes to complete the request to this API after calling the Login API. Once the identifier has expired you will need to call the Login API again to restart the process.

    This duration can be modified using the Tenant API or in the FusionAuth UI.

    Example Request JSON
    
    {
      "applicationId": "10000000-0000-0002-0000-000000000001",
      "code": "915187",
      "ipAddress": "192.168.1.42",
      "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
    }

    Response

    The response for this API contains the User object.

    Table 3. Response Codes
    Code Description

    200

    The authentication was successful. The response will contain the User object that was authenticated.

    202

    The user was authenticated successfully. The user is not registered for the application specified by applicationId on the request. The response will contain the User object that was authenticated.

    203

    The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API. Since version 1.15.0, the response will also contain a changePasswordReason field which can have one of the following values:

    • Administrative - An administrator has required this user to change their password.

    • Breached - The password has been found to have belonged to a breached dataset and must be changed, per the Reactor configuration.

    • Expired - The password has expired, per the expiration setting in the tenant configuration.

    • Validation - The password fails the validation rules configured in the tenant password settings.

    Example Response JSON
    
      {
      "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ",
      "changePasswordReason": "Expired"
    }

    212

    The user’s email address has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the emailVerificationId that was generated for the user.

    213

    The user’s registration has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the registrationVerificationId that was generated for the user.

    Prior to version 1.27.0, this status code was not returned, and you will see a 200 instead.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

    404

    The twoFactorId was invalid or expired. You will need to authenticate again using the Login API. The response will be empty.

    409

    The user is currently in an action that has prevented login. The response will contain the actions that prevented login.

    Example Response JSON
    
      {
      "actions": [
        {
          "actionId": "00000000-0000-0000-0000-000000000042",
          "actionerUserId": "00000000-0000-0001-0000-000000000000",
          "expiry": 1571786483322,
          "localizedName": "Prevent Login Action",
          "localizedReason": "Hard Lock",
          "name": "Prevent Login Action",
          "reason": "Hard Lock",
          "reasonCode": "hard_lock"
        }
      ]
    }

    410

    The user has expired. The response will be empty.

    421

    The code request parameter is not valid. 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

    refreshToken [String]

    The refresh token that can be used to obtain a new access token once the provided one has expired.

    Because a refresh token is per user and per application, this value will only be returned when an applicationId was provided on the login request and the user is registered to the application.

    You must explicitly allow generation of refresh tokens when using the Login API. Configure the application.loginConfiguration.generateRefreshTokens setting via the API or enable the setting by navigating to the Application → My Application → Security tab.

    refreshTokenId [String] Available since 1.37.0

    When the refreshToken is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the Refresh Token API.

    state [Object] Available since 1.26.0

    If authenticated using Two Factor and state was provided during the Two Factor Start request this value will be returned exactly as it was provided.

    trustToken [String] Available since 1.33.0

    A trust token that may be used to complete another API request that requires trust. For example, if you receive an error from an API indicating trust is required - indicated by this error code [TrustTokenRequired], this value can be used to satisfy the trust requirement.

    twoFactorTrustId [String]

    The Two Factor Trust identifier. This value is returned when trustComputer was set to true on the request. This value can be used by subsequent login requests to bypass the Two Factor challenge.

    token [String] Available since 1.16.0

    The access token, this string is an encoded JSON Web Token (JWT).

    tokenExpirationInstant [Long] Available since 1.33.0

    The instant the token will expire. If the response does not contain a token, this field will also be omitted from the response.

    user.active [Boolean]

    True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.

    user.birthDate [String]

    The User’s birthdate formatted as YYYY-MM-DD

    user.breachedPasswordLastCheckedInstant [Long]

    The instant this user’s password was last checked to determine if it is compromised.

    user.connectorId [UUID] Available since 1.18.0

    The unique Id of the Connector associated with the System of Record being used to authenticate the user.

    user.cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.data [Object]

    An object that can hold any information about the User that should be persisted.

    user.data.email [String]

    This field will be used as the email address if no user.email field is found.

    This feature was removed in version 1.26.0 and added back in in 1.27.2.

    user.email [String]

    The User’s email address.

    user.expiry [Long]

    The expiration instant of the User’s account. An expired user is not permitted to login.

    user.firstName [String]

    The first name of the User.

    user.fullName [String]

    The User’s full name as a separate field that is not calculated from firstName and lastName.

    user.id [UUID]

    The User’s unique Id.

    user.imageUrl [String]

    The URL that points to an image file that is the User’s profile image.

    user.insertInstant [Long]

    The instant when the user was created.

    user.lastLoginInstant [Long]

    The instant when the User logged in last.

    user.lastName [String]

    The User’s last name.

    user.lastUpdateInstant [Long]

    The instant when the User was last updated.

    user.memberships [Array]

    The list of memberships for the User.

    user.memberships[x].data [Object]

    An object that can hold any information about the User for this membership that should be persisted.

    user.memberships[x].groupId [UUID]

    The Id of the Group of this membership.

    user.memberships[x].id [UUID]

    The unique Id of this membership.

    user.memberships[x].insertInstant [Long]

    The instant that the membership was created.

    user.middleName [String]

    The User’s middle name.

    user.mobilePhone [String]

    The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.

    user.parentEmail [String] Available since 1.7.0

    The email address of the user’s parent or guardian. If this value was provided during a create or update operation, this value will only remain until the child is claimed by a parent.

    user.passwordChangeRequired [Boolean]

    Indicates that the User’s password needs to be changed during their next login attempt.

    user.passwordLastUpdateInstant [Long]

    The instant that the User last changed their password.

    user.preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text. See Locales.

    user.registrations [Array]

    The list of registrations for the User. This will include registrations for inactive applications.

    user.registrations[x].applicationId [UUID]

    The Id of the Application that this registration is for.

    user.registrations[x].authenticationToken [String]

    The Authentication Token for this registration (if one exists).

    user.registrations[x].cleanSpeakId [UUID]

    This Id is used by FusionAuth when the User’s username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

    user.registrations[x].data [Object]

    An object that can hold any information about the User for this registration that should be persisted.

    user.registrations[x].id [UUID]

    The Id of this registration.

    user.registrations[x].insertInstant [Long]

    The instant that this registration was created.

    user.registrations[x].lastLoginInstant [Long]

    The instant that the User last logged into the Application for this registration.

    user.registrations[x].preferredLanguages [Array<String>]

    An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

    user.registrations[x].roles [Array<String>]

    The list of roles that the User has for this registration.

    user.registrations[x].timezone [String]

    The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

    user.registrations[x].tokens [Map<String,String>] Deprecated

    A map that contains tokens returned from identity providers.

    For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name Facebook. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.

    Removed in 1.28.0

    The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider Link API.

    user.registrations[x].username [String]

    The username of the User for this registration only. This is for display purposes and cannot be used to login.

    user.registrations[x].usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.registrations[x].verified [Boolean]

    This value indicates if this User’s registration has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    user.tenantId [UUID]

    The Id of the Tenant that this User belongs to.

    user.timezone [String]

    The User’s preferred timezone. This can be used as a default to display instants, and it is recommended that you allow Users to change this per-session. The string will be in an IANA time zone format.

    user.twoFactor.methods[x].authenticator.algorithm [String]

    The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.

    user.twoFactor.methods[x].authenticator.codeLength [Integer]

    The length of code generated by the TOTP. With the current implementation, this will always be 6.

    user.twoFactor.methods[x].authenticator.timeStep [Integer]

    The time-step size in seconds. With the current implementation, this will always be 30.

    user.twoFactor.methods[x].email [String]

    The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.

    user.twoFactor.methods[x].id [String]

    The unique Id of the method.

    user.twoFactor.methods[x].lastUsed [Boolean]

    true if this method was used most recently.

    user.twoFactor.methods[x].method [String]

    The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are:

    • authenticator

    • email

    • sms

    user.twoFactor.methods[x].mobilePhone [String]

    The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.

    user.twoFactor.methods[x].secret [String]

    A base64 encoded secret

    user.twoFactorDelivery [String] Deprecated

    The User’s preferred delivery for verification codes during a two factor login request.

    The possible values are:

    • None

    • TextMessage

      Removed in version 1.26.0

    user.twoFactorEnabled [Boolean] Deprecated

    Determines if the User has two factor authentication enabled for their account or not.

    Removed in version 1.26.0

    user.username [String]

    The username of the User.

    user.usernameStatus [String]

    The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

    • ACTIVE - the username is active

    • PENDING - the username is pending approval/moderation

    • REJECTED - the username was rejected during moderation

    If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

    user.verified [Boolean]

    Whether or not the User’s email has been verified.

    For additional information, see these tutorials:

    • Email Verification

    • Registration Verification

    Example Response JSON
    
    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
      "user": {
        "active": true,
        "birthDate": "1976-05-30",
        "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
        "data": {
          "displayName": "Johnny Boy",
          "favoriteColors": [
            "Red",
            "Blue"
          ]
        },
        "email": "example@fusionauth.io",
        "expiry": 1571786483322,
        "firstName": "John",
        "fullName": "John Doe",
        "id": "00000000-0000-0001-0000-000000000000",
        "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
        "lastLoginInstant": 1471786483322,
        "lastName": "Doe",
        "middleName": "William",
        "mobilePhone": "303-555-1234",
        "passwordChangeRequired": false,
        "passwordLastUpdateInstant": 1471786483322,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "registrations": [
          {
            "applicationId": "10000000-0000-0002-0000-000000000001",
            "data": {
              "displayName": "Johnny",
              "favoriteSports": [
                "Football",
                "Basketball"
              ]
            },
            "id": "00000000-0000-0002-0000-000000000000",
            "insertInstant": 1446064706250,
            "lastLoginInstant": 1456064601291,
            "preferredLanguages": [
              "en",
              "fr"
            ],
            "roles": [
              "user",
              "community_helper"
            ],
            "username": "johnny123",
            "usernameStatus": "ACTIVE"
          }
        ],
        "timezone": "America/Denver",
        "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
        "twoFactorEnabled": false,
        "usernameStatus": "ACTIVE",
        "username": "johnny123",
        "verified": true
      }
    }

    Response Cookies

    access_token [String]

    The encoded access token. This cookie is written in the response as an HTTP Only session cookie.

    refresh_token [String]

    The refresh token. This cookie is written in the response as an HTTP Only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.

    fusionauth.trust [String]

    The Multi-Factor Trust identifier. This value is returned when trustComputer was set to true on the request. This value can be used by subsequent login requests to bypass the Multi-Factor challenge. This cookie is written in the response as an HTTP Only persistent cookie.

    Update Login Instant

    Sends a ping to FusionAuth indicating that the user has authenticated, and (optionally) automatically logged into an application. When using FusionAuth’s SSO or your own, you should call this if the user is already logged in centrally, but accesses an application where they no longer have a session. This helps correctly track login counts, times and helps with reporting.

    Request

    Update the login instant for a given User and Application

    URI

    PUT /api/login/{userId}/{applicationId}?ipAddress={ipAddress}

    Request Headers

    X-Forwarded-For [String] Optional

    The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available, the request body value will take precedence.

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Parameters

    userId [UUID] Required

    The Id of the user logging in.

    applicationId [UUID] Optional

    The Id of the Application the user is to be logged into. This parameter is optional but there is not likely a production use case where you want to omit the value. If this parameter is omitted the user will still be authenticated but a login count will not be recorded for an Application.

    See the difference between authentication and authorization for more detail.

    ipAddress [String] Optional

    The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

    Update the login instant for a given User and Application using a JWT

    URI

    PUT /api/login?ipAddress={ipAddress}

    The userId is not required on the request. The userId and applicationId values will be retrieved from the identity claims in the JWT payload.

    Request Parameters

    ipAddress [String] Optional

    The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The update was successful.

    202

    The user exists but is not registered for the application specified by applicationId on the request.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

    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 user was not found.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    Logout a User

    The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token. This API does nothing if the request does not contain an access token or refresh token cookies.

    The refresh token is only revoked if the request contains the refresh_token cookie or the refreshToken request parameter.

    Request

    Remove the access_token and refresh_token cookies if they exist on the client.

    URI

    POST /api/logout

    Request Cookies

    access_token [String] Optional

    The access token cookie. When this cookie available in the request it will be deleted from the client.

    refresh_token [String] Optional

    The refresh token cookie. When this cookie available in the request it will be deleted from the client and revoked in FusionAuth.

    Request Headers

    X-FusionAuth-TenantId [String] Optional

    The unique Id of the tenant used to scope this API request.

    The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

    Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

    See Making an API request using a Tenant Id for additional information.

    Request Body

    global [Boolean] Optional defaults to false

    When this value is set to true all of the refresh tokens issued to the owner of the provided refresh token will be revoked. If no refresh token is provided on the request no refresh tokens will be revoked.

    refreshToken [String] Optional

    The refresh_token as a request parameter instead of coming in via a cookie. If provided this takes precedence over the cookie.

    Response

    This API does not return a JSON response body.

    Table 5. Response Codes
    Code Description

    200

    The update was successful.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files.

    Search Login Records

    Available Since Version 1.7.0

    This API allows you to search and paginate through the Login Records. Login Records are created in the following scenarios:

    • A login is completed using any Login API (normal, one-time, passwordless, Identity Provider, Connector).

    • A User is created with a password, whether self service or using the Registration API.

    • A Refresh Token is exchanged for a JWT.

    • A 2FA login is completed.

    You can limit the number of Login Records retained by navigating to Settings → System → Advanced → Login record settings and configuring automatic deletion of Login Records after a certain number of days.

    Request

    Searches for Login Records given search criteria

    URI

    GET /api/system/login-record/search?applicationId={applicationId}&start={start}&end={end}&userId={userId}

    When calling the API using a GET request you will send the search criteria on the URL using request parameters. In order to simplify the example URL above, not every possible parameter is shown, however using the provided pattern you may add any of the documented request parameters to the URL.

    Request Parameters

    applicationId [UUID] Optional

    The unique Id of the Application used to narrow the search results to logins for a particular application.

    end [Long] Optional

    The end instant of the date/time range to search within.

    numberOfResults [Integer] Optional defaults to 25

    The number of results to return from the search.

    retrieveTotal [Boolean] Optional defaults to false

    Set this to true if you want the total possible results returned in the response. With a very large number of login records settings this value to true will increase the response time of this request.

    start [Long] Optional

    The start instant of the date/time range to search within.

    startRow [Integer] Optional defaults to 0

    The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

    userId [String] Optional

    The unique Id of the User used to narrow the search results to login records for a particular user.

    Searches for Login Records given search criteria

    URI

    POST /api/system/login-record/search

    When calling the API using a POST request you will send the search criteria in a JSON request body.

    Request Body

    retrieveTotal [Boolean] Optional defaults to false

    Set this to true if you want the total possible results returned in the response. With a very large number of login records settings this value to true will increase the response time of this request.

    search.applicationId [UUID] Optional

    The unique Id of the Application used to narrow the search results to logins for a particular application.

    search.end [Long] Optional

    The end instant of the date/time range to search within.

    search.numberOfResults [Integer] Optional defaults to 25

    The number of results to return from the search.

    search.start [Long] Optional

    The start instant of the date/time range to search within.

    search.startRow [Integer] Optional defaults to 0

    The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.

    search.userId [UUID] Optional

    The unique Id of the User used to narrow the search results to login records for a particular user.

    Response

    The response for this API will contain all login records matching the search criteria in paginated format.

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

    logins [Array]

    The list of Login Records returned by the search.

    logins[x].applicationId [UUID]

    The unique Id of the application.

    logins[x].applicationName [String]

    The name of the application. Because the application name may be modified after the login event occurred, only the applicationId should be considered immutable for historical purposes when identifying the application.

    logins[x].loginId [String]

    The email or username of the user. Because email or username may be modified after the login event occurred, only the userId and the should be considered immutable for historical purposes when identifying the user.

    logins[x].instant [Long]

    The instant when the login occurred.

    logins[x].ipAddress [String]

    The recorded IP address for this login record.

    logins[x].userId [UUID]

    The unique Id of the user.

    total [Long]

    The total number of login records available. This will only be provided in the response when retrieveTotal was set to true on the request.

    Example JSON Response
    
    {
      "logins": [
        {
          "applicationId": "2edd54c6-695d-409e-b8af-2d3ebf73711a",
          "applicationName": "Pied Piper Admin Portal",
          "loginId": "richard@piedpiper.com",
          "instant": 1562608320303,
          "ipAddress": "42.42.42.42",
          "userId": "d7be5e1e-0020-4f6f-a9dc-0f9230650042"
        },
        {
          "applicationId": "3c219e58-ed0e-4b18-ad48-f4f92793ae32",
          "applicationName": "FusionAuth",
          "loginId": "monica@piedpiper.com",
          "instant": 1562608320901,
          "ipAddress": "192.168.1.1",
          "userId": "af8fb4d8-df6b-41c6-9843-813da943b005"
        },
        {
          "applicationId": "2edd54c6-695d-409e-b8af-2d3ebf73711a",
          "applicationName": "Pied Piper Admin Portal",
          "loginId": "richard@piedpiper.com",
          "instant": 1562608399639,
          "ipAddress": "42.42.42.42",
          "userId": "d7be5e1e-0020-4f6f-a9dc-0f9230650042"
        }
      ],
      "total": 3
    }

    Export Login Records

    Available Since Version 1.7.0

    This API is used to export Login Records, the response will be a compressed zip archive of CSV files.

    Request

    Export the Login Records matching the criteria

    URI

    GET /api/system/login-record/export?applicationId={applicationId}&start={start}&end={end}&userId={userId}

    When calling the API using a GET request you will send the export criteria on the URL using request parameters. In order to simplify the example URL above, not every possible parameter is shown, however using the provided pattern you may add any of the documented request parameters to the URL.

    Request Parameters

    applicationId [UUID] Optional

    The unique Id of the Application used to reduce the export result to logins for a particular application.

    dateTimeSecondsFormat [String] Optional defaults to [see description]

    The format string used to format the date and time columns in the export result.

    When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

    end [Long] Optional

    The end instant of the date/time range to search within.

    start [Long] Optional

    The start instant of the date/time range to search within.

    userId [UUID] Optional

    The unique Id of the User used to reduce the export result to logins for a particular user.

    zoneId [String] Optional defaults to [see description].

    The time zone used to adjust the stored UTC time in the export result.

    For example:

    America/Denver or US/Mountain

     

    When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

    Export the Login Records matching the criteria

    URI

    POST /api/system/login-record/export

    When calling the API using a POST request you will send the export criteria in a JSON request body.

    Request Body

    criteria.applicationId [UUID] Optional

    The unique Id of the Application used to reduce the export result to logins for a particular application.

    criteria.end [Long] Optional

    The end instant of the date/time range to include in the export.

    criteria.start [Long] Optional

    The start instant of the date/time range to include in the export.

    criteria.userId [UUID] Optional

    The unique Id of the User used to reduce the export result to logins for a particular user.

    dateTimeSecondsFormat [String] Optional defaults to [see description]

    The format string used to format the date and time columns in the export result.

    When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

    zoneId [String] Optional defaults to [see description]

    The time zone used to adjust the stored UTC time in the export result.

    For example:

    America/Denver or US/Mountain

     

    When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

    Response

    The response for this API will contain a compressed zip of the audit logs.

    Table 7. Response Codes
    Code Description

    200

    The request was successful. The response will be a compressed archive byte stream with a Content-Type of application/zip.

    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.

    Sample file export
    
    "User Id ","Time ","Application Id ","IP Address ","City ","Country ","Zipcode ","Region ","Latitude ","Longitude "
    00000000-0000-0000-0000-000000000001,5/12/2022 02:46:44 PM MDT,,107.170.227.24,San Francisco,US,,CA,37.7309,-122.3886
    00000000-0000-0000-0000-000000000001,5/12/2022 12:25:12 AM MDT,3c219e58-ed0e-4b18-ad48-f4f92793ae32,127.0.0.1,,,,,,

    The location information is only included in exports when Advanced Threat Detection is enabled.

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