getusersinrole.md

Get Users of a Role

Gets the users that belong to a specific role.

HTTP Method	URL	Requires Auth
GET	/api/v1/roles.getUsersInRole	yes

Query Parameters

This endpoint supports the optional offset and count #pagination query parameters.

Key	Example Value	Description
role*	admin	The role.
roomId	GENERAL	The room ID.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/roles.getUsersInRole

Example Response

{
  "users": [
    {
      "_id": "voakrL3cHjYBwwRPq",
      "username": "a",
      "type": "user",
      "status": "offline",
      "active": true,
      "name": "a"
    },
    {
      "_id": "N2s7KG6YkzgJfXbyn",
      "username": "b",
      "type": "user",
      "status": "offline",
      "active": true,
      "name": "b"
    },
  ],
  "success": true
}

Change Log

Version	Description
1.3.0	Added