Authentication
To access the Rocket.Chat API, you need to authenticate using your
username
and password
. This authentication method allows you to interact securely with the Rocket.Chat server and perform actions on behalf of the authenticated user.Upon successful authentication, the API will provide an authentication token (
authToken
) and a unique user identifier (userId
) as part of the JSON response. These values should be used as headers in subsequent requests to protected endpoints that require authentication.The
authToken
is passed as X-Auth-Token
header, while the userId
as X-User-Id
header.
Url | Short Description | Details Page |
---|---|---|
/api/v1/login | Authenticate with username and password. | |
/api/v1/login | Authenticate with facebook. | |
/api/v1/login | Authenticate with google. | |
/api/v1/login | Authenticate with twitter. | |
/api/v1/logout | Invalidate your REST API authentication token. | |
/api/v1/me | Displays information about the authenticated user. |
Last modified 3mo ago