Rocket.Chat Documentation - Login

#1

Login

URL Requires Auth HTTP Method /api/v1/login no POST

Payload

Argument Example Required Description username myusername Required Your username password my$up3erP@ssw0rd Required Your password
  • Notes:
  • You will need to provide the authToken and userId for any of the authenticated methods.

Example Call - As Form Data

curl http://localhost:3000/api/v1/login \
     -d "username=myusername&password=mypassword"

curl http://localhost:3000/api/v1/login \
     -d "user=myusername&password=mypassword"

curl http://localhost:3000/api/v1/login \
     -d "user=my@email.com&password=mypassword"

Example Call - As JSON

curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "username": "myusername", "password": "mypassword" }'

curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "user": "myusername", "password": "mypassword" }'

curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "user": "my@email.com", "password": "mypassword" }'

Result

{
  "status": "success",
  "data": {
      "authToken": "9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq",
      "userId": "aobEdbYhXfu5hkeqG",
      "me": {
            "_id": "aYjNnig8BEAWeQzMh",
            "name": "Rocket Cat",
            "emails": [
                {
                  "address": "rocket.cat@rocket.chat",
                  "verified": false
                }
            ],
            "status": "offline",
            "statusConnection": "offline",
            "username": "rocket.cat",
            "utcOffset": -3,
            "active": true,
            "roles": [
                "admin"
            ],
            "settings": {
                "preferences": {}
              }
        }
   }
}

Change Log

Version Description 0.64.0 Added me property to response 0.60.0 Added
This is a companion discussion topic for the original entry at https://rocket.chat/docs/developer-guides/rest-api/authentication/login/