Create Users Token

IMPORTANT To be able to use this endpoint you must set the ENV VAR (CREATE_TOKENS_FOR_USERS=true).
Create a user authentication token. This is the same type of session token a user would get via login and will expire the same way. Requires user-generate-access-token permission.
Example if you use snaps:
1
    echo "CREATE_TOKENS_FOR_USERS=true" > /var/snap/rocketchat-server/common/create-tokens.env
2
    sudo systemctl restart snap.rocketchat-server.rocketchat-server.service
Copied!
Create a user authentication token. Requires user-generate-access-token permission.
URL
Requires Auth
HTTP Method
/api/v1/users.createToken
yes
POST
Payload
Argument
Example
Required
Description
userId or username
BsNr28znDkG8aeo7W
Required
The id or username of the user.
Example Call - Via userId
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     -H "Content-type:application/json" \
4
     http://localhost:3000/api/v1/users.createToken \
5
     -d '{ "userId": "BsNr28znDkG8aeo7W" }'
Copied!
Example Result
1
{
2
  "data": {
3
    "userId": "BsNr28znDkG8aeo7W",
4
    "authToken": "2jdk99wuSjXPO201XlAks9sjDjAhSJmskAKW301mSuj9Sk",
5
  },
6
  "success": true
7
}
Copied!
Example Call - Via username
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
     -H "Content-type:application/json" \
4
     http://localhost:3000/api/v1/users.createToken \
5
     -d '{ "username": "test" }'
Copied!
Example Result
1
{
2
  "data": {
3
    "userId": "BsNr28znDkG8aeo7W",
4
    "authToken": "2jdk99wuSjXPO201XlAks9sjDjAhSJmskAKW301mSuj9Sk",
5
  },
6
  "success": true
7
}
Copied!
Change Log
Version
Description
2.1.0
Added ENV VAR to be able to use this endpoint (process.env.CREATE_TOKENS_FOR_USERS).
0.56.0
Added

Update own basic information

Get User Preferences

Last modified 1yr ago

Export as PDF

Copy link

Edit on GitHub

Contents

Payload

Example Call - Via userId

Example Result

Example Call - Via username

Example Result

Change Log