Links
Comment on page

Login with Google

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

Body Parameters

Key
Example Value
Description
serviceName*
google
The desired OAuth service name. In this case, google.
accessToken*
hash
Access token provided by Google OAuth.
idToken*
hash
The ID token provided by Google OAuth.
expiresIn*
200
Lifetime of token (in seconds).
scope
profile
Google scopes for API.

Example Call - As JSON

curl -H "Content-type:application/json" \
http://localhost:3000/api/v1/login \
-d '{
"serviceName": "google",
"accessToken": "hash",
"idToken": "hash",
"expiresIn": 200,
"scope": "profile" }'

Example Response

{
"status": "success",
"data": {
"authToken": "9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq",
"userId": "aobEdbYhXfu5hkeqG",
"me": {
"_id": "aYjNnig8BEAWeQzMh",
"name": "Rocket Cat",
"emails": [
{
"address": "[email protected]",
"verified": false
}
],
"status": "offline",
"statusConnection": "offline",
"username": "rocket.cat",
"utcOffset": -3,
"active": true,
"roles": [
"admin"
],
"settings": {
"preferences": {}
},
"avatarUrl": "http://localhost:3000/avatar/test"
}
}
}

Change Log

Version
Description
1.0.0
Added avatarUrl property to response
0.64.0
Added me property to response
0.60.0
Added
Last modified 5d ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.