Get Updated Roles

Gets all the roles in the system, which are updated after a given date.

HTTP MethodURLRequires Auth

GET

/api/v1/roles.sync

Query Parameters

KeyExample ValueDescription

updatedSince*

2017-11-25T15:08:17.248Z

Date as ISO string.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/roles.sync?updatedSince=2017-11-25T15:08:17.248Z

Example Response

{
  "roles": {
   "update" :[
      {
        "_id": "admin",
        "description": "Admin",
        "mandatory2fa": false,
        "protected": true,
        "scope": "Users"
      }
    ],
    "remove" : [
      {
        "_id": "user",
        "description": "User",
        "mandatory2fa": false,
        "protected": true,
        "scope": "Users"
      }
    ]
  },
  "success": true
}

Change Log

VersionDescription

3.1.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.