Login APIs
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.
Request Headers
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.
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
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
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.
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.
The login identifier of the user. The login identifier can be either the email or the username .
Note: The value will be used exactly as provided to resolve a user by email or the username . If the provided value contains leading or trailing white space these characters will not be removed, and then would only match a user by email or the username if the values stored in FusionAuth also contain these same leading or trailing spaces.
You may optionally normalize this value prior to sending it to FusionAuth. If you are using a hosted login page, FusionAuth will use this API to complete login during an OAuth2 or SAML v2 workflow. In this case, you may optionally normalize or validate the user input client side using JavaScript or HTML 5 validation to achieve the same result.
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.
The IP address which made this request.
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.
The type of device represented by the device parameter.
Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
In version 1.46.0 and beyond, this value can be any string value you’d like, have fun with it!
This meta data is used to describe the refresh token that may be generated for this request.
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.
The user’s password or an Application specific Authentication Token.
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.
{
"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.
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.
{
"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 <InlineField>emailConfiguration.verificationStrategy</InlineField> 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 <InlineField>emailConfiguration.verificationStrategy</InlineField> 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. Since version 1.42.0, this status code is also returned when two factor authentication is required. The response will contain the twoFactorId to be used on the Complete Two Factor Authentication API. |
{
"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. |
| 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. |
{
"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. |
| 504 | One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files. |
Response Body
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.
True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.
The User’s birthdate formatted as YYYY-MM-DD
The instant this user’s password was last checked to determine if it is compromised.
The unique Id of the Connector associated with the System of Record being used to authenticate the user.
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.
An object that can hold any information about the User that should be persisted.
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.
The User’s email address.
The expiration instant of the User’s account. An expired user is not permitted to login.
The first name of the User.
The User’s full name as a separate field that is not calculated from firstName and lastName .
The User’s unique Id.
The URL that points to an image file that is the User’s profile image.
The instant when the user was created.
The instant when the User logged in last.
The User’s last name.
The instant when the User was last updated.
The User’s middle name.
The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.
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.
Indicates that the User’s password needs to be changed during their next login attempt.
The instant that the User last changed their password.
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.
The list of registrations for the User. This will include registrations for inactive applications.
The Id of the Application that this registration is for.
The Authentication Token for this registration (if one exists).
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.
An object that can hold any information about the User for this registration that should be persisted.
The Id of this registration.
The instant that this registration was created.
The instant that the User last logged into the Application for this registration.
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.
The list of roles that the User has for this registration.
The User’s preferred timezone for this registration. The string will be in an IANA time zone format.
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.
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.
The username of the User for this registration only. This is for display purposes and cannot be used to login.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
This value indicates if this User’s registration has been verified.
For additional information, see these tutorials:
The instant that this registration was verified.
The Id of the Tenant that this User belongs to.
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.
The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
The length of code generated by the TOTP. With the current implementation, this will always be 6.
The time-step size in seconds. With the current implementation, this will always be 30.
The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.
The unique Id of the method.
true if this method was used most recently.
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:
authenticatoremailsms
The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.
A base64 encoded secret
The User’s preferred delivery for verification codes during a two factor login request.
The possible values are:
NoneTextMessage
Determines if the User has two factor authentication enabled for their account or not.
Removed in 1.26.0The username of the User.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
Whether or not the User’s email has been verified.
For additional information, see these tutorials:
The instant that this email address was verified.
Note that this value is immutable and will only represent the first time the email was verified. If you enable re-verification on email change, this value will not change and will only represent the initial verification.
{
"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",
"verified": true,
"verifiedInstant": 1698772159415
}
],
"timezone": "America/Denver",
"tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
"twoFactorEnabled": false,
"usernameStatus": "ACTIVE",
"username": "johnny123",
"verified": true,
"verifiedInstant": 1698772159415
}
}Response Cookies
The encoded access token. This cookie is written in the response as an HTTP Only session cookie.
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.
Request Headers
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.
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
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.
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.
The one time password returned by the Change Password API. This value takes the place of the loginId and the password fields.
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.
The IP address which made this request.
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.
The type of device represented by the device parameter.
Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
In version 1.46.0 and beyond, this value can be any string value you’d like, have fun with it!
This meta data is used to describe the refresh token that may be generated for this request.
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.
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.
{
"oneTimePassword": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4",
"applicationId": "10000000-0000-0002-0000-000000000001",
"ipAddress": "192.168.1.42"
}Response
The response for this API contains the User object.
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.
{
"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 <InlineField>emailConfiguration.verificationStrategy</InlineField> 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 <InlineField>emailConfiguration.verificationStrategy</InlineField> 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. Since version 1.42.0, this status code is also returned when two factor authentication is required. The response will contain the twoFactorId to be used on the Complete Two Factor Authentication API. |
{
"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. |
| 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. |
{
"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. |
| 504 | One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files. |
Response Body
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.
True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.
The User’s birthdate formatted as YYYY-MM-DD
The instant this user’s password was last checked to determine if it is compromised.
The unique Id of the Connector associated with the System of Record being used to authenticate the user.
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.
An object that can hold any information about the User that should be persisted.
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.
The User’s email address.
The expiration instant of the User’s account. An expired user is not permitted to login.
The first name of the User.
The User’s full name as a separate field that is not calculated from firstName and lastName .
The User’s unique Id.
The URL that points to an image file that is the User’s profile image.
The instant when the user was created.
The instant when the User logged in last.
The User’s last name.
The instant when the User was last updated.
The User’s middle name.
The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.
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.
Indicates that the User’s password needs to be changed during their next login attempt.
The instant that the User last changed their password.
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.
The list of registrations for the User. This will include registrations for inactive applications.
The Id of the Application that this registration is for.
The Authentication Token for this registration (if one exists).
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.
An object that can hold any information about the User for this registration that should be persisted.
The Id of this registration.
The instant that this registration was created.
The instant that the User last logged into the Application for this registration.
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.
The list of roles that the User has for this registration.
The User’s preferred timezone for this registration. The string will be in an IANA time zone format.
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.
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.
The username of the User for this registration only. This is for display purposes and cannot be used to login.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
This value indicates if this User’s registration has been verified.
For additional information, see these tutorials:
The instant that this registration was verified.
The Id of the Tenant that this User belongs to.
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.
The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
The length of code generated by the TOTP. With the current implementation, this will always be 6.
The time-step size in seconds. With the current implementation, this will always be 30.
The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.
The unique Id of the method.
true if this method was used most recently.
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:
authenticatoremailsms
The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.
A base64 encoded secret
The User’s preferred delivery for verification codes during a two factor login request.
The possible values are:
NoneTextMessage
Determines if the User has two factor authentication enabled for their account or not.
Removed in 1.26.0The username of the User.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
Whether or not the User’s email has been verified.
For additional information, see these tutorials:
The instant that this email address was verified.
Note that this value is immutable and will only represent the first time the email was verified. If you enable re-verification on email change, this value will not change and will only represent the initial verification.
{
"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",
"verified": true,
"verifiedInstant": 1698772159415
}
],
"timezone": "America/Denver",
"tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
"twoFactorEnabled": false,
"usernameStatus": "ACTIVE",
"username": "johnny123",
"verified": true,
"verifiedInstant": 1698772159415
}
}Response Cookies
The encoded access token. This cookie is written in the response as an HTTP Only session cookie.
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.
Request Headers
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.
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
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.
The Multi-Factor verification code. This may also be a recovery code.
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.
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.
The IP address which made this request.
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.
The type of device represented by the device parameter.
Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
In version 1.46.0 and beyond, this value can be any string value you’d like, have fun with it!
This meta data is used to describe the refresh token that may be generated for this request.
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.
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.
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.
{
"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.
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:
|
| 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 |
| 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. |
| 504 | One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files. |
Response Body
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.
True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to login.
The User’s birthdate formatted as YYYY-MM-DD
The instant this user’s password was last checked to determine if it is compromised.
The unique Id of the Connector associated with the System of Record being used to authenticate the user.
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.
An object that can hold any information about the User that should be persisted.
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.
The User’s email address.
The expiration instant of the User’s account. An expired user is not permitted to login.
The first name of the User.
The User’s full name as a separate field that is not calculated from firstName and lastName .
The User’s unique Id.
The URL that points to an image file that is the User’s profile image.
The instant when the user was created.
The instant when the User logged in last.
The User’s last name.
The instant when the User was last updated.
The User’s middle name.
The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.
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.
Indicates that the User’s password needs to be changed during their next login attempt.
The instant that the User last changed their password.
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.
The list of registrations for the User. This will include registrations for inactive applications.
The Id of the Application that this registration is for.
The Authentication Token for this registration (if one exists).
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.
An object that can hold any information about the User for this registration that should be persisted.
The Id of this registration.
The instant that this registration was created.
The instant that the User last logged into the Application for this registration.
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.
The list of roles that the User has for this registration.
The User’s preferred timezone for this registration. The string will be in an IANA time zone format.
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.
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.
The username of the User for this registration only. This is for display purposes and cannot be used to login.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
This value indicates if this User’s registration has been verified.
For additional information, see these tutorials:
The instant that this registration was verified.
The Id of the Tenant that this User belongs to.
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.
The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.
The length of code generated by the TOTP. With the current implementation, this will always be 6.
The time-step size in seconds. With the current implementation, this will always be 30.
The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.
The unique Id of the method.
true if this method was used most recently.
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:
authenticatoremailsms
The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.
A base64 encoded secret
The User’s preferred delivery for verification codes during a two factor login request.
The possible values are:
NoneTextMessage
Determines if the User has two factor authentication enabled for their account or not.
Removed in 1.26.0The username of the User.
The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:
ACTIVE- the username is activePENDING- the username is pending approval/moderationREJECTED- 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.
Whether or not the User’s email has been verified.
For additional information, see these tutorials:
The instant that this email address was verified.
Note that this value is immutable and will only represent the first time the email was verified. If you enable re-verification on email change, this value will not change and will only represent the initial verification.
{
"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",
"verified": true,
"verifiedInstant": 1698772159415
}
],
"timezone": "America/Denver",
"tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
"twoFactorEnabled": false,
"usernameStatus": "ACTIVE",
"username": "johnny123",
"verified": true,
"verifiedInstant": 1698772159415
}
}Response Cookies
The encoded access token. This cookie is written in the response as an HTTP Only session cookie.
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.
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
Request Headers
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.
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
The Id of the user logging in.
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.
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.
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
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
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.
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
Request Cookies
The access token cookie. When this cookie available in the request it will be deleted from the client.
The refresh token cookie. When this cookie available in the request it will be deleted from the client and revoked in FusionAuth.
Request Headers
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
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.
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.
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
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
The unique Id of the Application used to narrow the search results to logins for a particular application.
The end instant of the date/time range to search within.
The number of results to return from the search.
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.
The start instant of the date/time range to search within.
The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.
The unique Id of the User used to narrow the search results to login records for a particular user.
When calling the API using a POST request you will send the search criteria in a JSON request body.
Request Body
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.
The unique Id of the Application used to narrow the search results to logins for a particular application.
The end instant of the date/time range to search within.
The number of results to return from the search.
The start instant of the date/time range to search within.
The offset into the total results. In order to paginate the results, increment this value by the numberOfResults for subsequent requests.
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.
| 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
The list of Login Records returned by the search.
The unique Id of the application.
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.
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.
The instant when the login occurred.
The recorded IP address for this login record.
The unique Id of the user.
The total number of login records available. This will only be provided in the response when retrieveTotal was set to true on the request.
{
"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
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
The unique Id of the Application used to reduce the export result to logins for a particular application.
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.
The end instant of the date/time range to search within.
The start instant of the date/time range to search within.
The unique Id of the User used to reduce the export result to logins for a particular user.
The time zone used to adjust the stored UTC time in the export result.
For example:
America/DenverorUS/Mountain
When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.
When calling the API using a POST request you will send the export criteria in a JSON request body.
Request Body
The unique Id of the Application used to reduce the export result to logins for a particular application.
The end instant of the date/time range to include in the export.
The start instant of the date/time range to include in the export.
The unique Id of the User used to reduce the export result to logins for a particular user.
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.
The time zone used to adjust the stored UTC time in the export result.
For example:
America/DenverorUS/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.
| Code | Description |
|---|---|
| 200 | The request was successful. The response will be a compressed archive byte stream with a |
| 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.