Retrieves the user by a verificationId. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username. OR Retrieves the user for the given username. OR Retrieves the user for the loginId, using specific loginIdTypes. OR Retrieves the user for the loginId. The loginId can be either the username or the email. OR Retrieves the user for the given email. OR Retrieves the user by a change password Id. The intended use of this API is to retrieve a user after the forgot password workflow has been initiated and you may not know the user's email or username.

get/api/user

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/user
  • Auth: API key in header Authorization

Query parameters

verificationIdstring

The unique verification Id that has been set on the user object.

usernamestring

The username of the user.

loginIdstring

The email or username of the user.

loginIdTypesstring[]

The identity types that FusionAuth will compare the loginId to.

emailstring

The email of the user.

changePasswordIdstring

The unique change password Id that was sent via email or returned by the Forgot Password API.

Headers

X-FusionAuth-TenantIdstring UUID

The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.

Response

Success

emailVerificationIdstring
emailVerificationOneTimeCodestring
registrationVerificationIdsobject
registrationVerificationOneTimeCodesobject
tokenstring
tokenExpirationInstantinteger

The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.

Example response

{
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.