v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Users

Gets a user access token

Authenticates a user with an email and a password and gets a user access token upon the successful authentication. The user email must be registered with a valid HERE Account. Optionally user can provide requested realm ID.

post/users/v2/login

Request body

emailstring required

The email address of the user

passwordstring required

The password of the user

realmstring

A case-insensitive requested realm ID

Response

Success

The authentication was successful and a valid access token was returned.

accessTokenstring
expiresIninteger

The lifetime in seconds of the access token. For example 86400 means the token will expire in 24 hours from the time the response was generated.

realmstring

Current realm ID

refreshTokenstring
tokenTypestring

The token type is bearer

userIdstring

The HERE Account ID of a user.

Example response

{
  "accessToken": "h1.2...EyS_b6g3uDcKnpknGWQ",
  "expiresIn": 86400,
  "realm": "here",
  "refreshToken": "5qlkthf8mgl5lsrn8br5vdisco",
  "userId": "HERE-12345678-9abc-4def-0123-456789abcdef"
}