Info

Retrieves information about a user, the result is only limited to what the callee has access to view. It supports Fields Query Parameter with the userRooms field, that returns the rooms that the user is part of.

URL

Requires Auth

HTTP Method

/api/v1/users.info

yes

GET

Query Parameters

Argument

Example

Required

Description

userId or username

BsNr28znDkG8aeo7W

Required

The id or username of the user.

Other Users Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/users.info?userId=BsNr28znDkG8aeo7W

Example Result Regular User Callee

{
"user": {
"_id": "nSYqWzZ4GsKTX4dyK",
"type": "user",
"status": "offline",
"active": true,
"name": "Example User",
"utcOffset": 0,
"username": "example"
},
"success": true
}

Example Result Admin Callee that requests user's rooms

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/users.info?userId=BsNr28znDkG8aeo7W&fields={"userRooms": 1}
{
"user": {
"_id": "nSYqWzZ4GsKTX4dyK",
"createdAt": "2016-12-07T15:47:46.861Z",
"services": {
"password": {
"bcrypt": ...
},
"email": {
"verificationTokens": [
{
"token": "...",
"address": "example@example.com",
"when": "2016-12-07T15:47:46.930Z"
}
]
},
"resume": {
"loginTokens": [
{
"when": "2016-12-07T15:47:47.334Z",
"hashedToken": "..."
}
]
}
},
"emails": [
{
"address": "example@example.com",
"verified": true
}
],
"type": "user",
"status": "offline",
"active": true,
"roles": [
"user"
],
"name": "Example User",
"lastLogin": "2016-12-08T00:22:15.167Z",
"statusConnection": "offline",
"utcOffset": 0,
"username": "example",
"rooms": [
{
"_id": "PoffwDEebAwcmS5A8",
"rid": "GENERAL",
"name": "general",
"t": "c"
},
{
"_id": "hr93s8GcJedZbkeaH",
"rid": "oaqXoFLru3YLuau2J",
"name": "test",
"t": "c",
"roles": [
"owner"
]
}
]
},
"success": true
}

Change Log

Version

Description

0.70.0

Added rooms property to response if the user request it and has the view-other-user-channels permission

0.49.0

Updated to support userId or username

0.48.0

Renamed to users.info

0.35.0

Added as user.info