Skip to main content

For an introduction into setting up RESTful hal+json refer to the set-up documentation.  Also see the Query - user screen.

Login a member

POST: {domain}/user/login?_format=hal_json
Content-type: application/hal_json
Accept: application/hal+json

{
"name": "username",
"pass": "password"
}

Example:

{
"name": "jacque",
"pass": "nOtmYp1ssWorD"
}
Example response
{
    "current_user": {
        "uid": "200",
        "name": "jacque"
    },
    "csrf_token": "kHVeh_ZWh5mwzZxrZGwc0smH3M5vfNX5C6H6oFyEVik",
    "logout_token": "VGvCWlByqwU4r5d_D45t4Kj1TShDaCdNrEZZ3qtuAUQ"
}

If you are using json rather than hal_json, then accordingly alter the above to match.  For example

POST: {domain}/user/login?_format=json
Content-type: application/json
Accept: application/json

 

Logout a member

GET {domain}/user/logout?_format=json&token={token}
Content-type: text/html

Replace {token} with your logout_token when the respective user logged in... for example

{
   "logout_token": "VGvCWlByqwU4r5d_D45t4Kj1TShDaCdNrEZZ3qtuAUQ"
}

As noted from the example above.

 

Retrieve a user's details

GET {domain}/user/{uid}?_format=hal_json

For more details regarding retrieving a user's details go to Query - user.

 

Recover / change a user's password

Have read through this article - How to recover or change or reset your password using REST.

 

Check if a user is logged in or not

To confirm a user is logged in use:

GET {domain}/user/login_status?_format=json

If the user is logged in the response will be

1

Otherwise, a non logged user will be

0

 

Related articles