Gets the roles in the workspace that were created, updated, or deleted after a given date.
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Added |
The authenticated user ID.
The authenticated user token.
Date as an ISO string. Roles updated at or after this date are returned in update, and roles deleted after this date are returned in remove.
OK
{
"roles": {
"update": [
{
"_id": "admin",
"scope": "Users",
"description": "Admin",
"mandatory2fa": false,
"name": "admin",
"protected": true,
"_updatedAt": "2026-11-07T02:22:08.393Z"
},
{
"_id": "moderator",
"scope": "Subscriptions",
"description": "Moderator",
"mandatory2fa": false,
"name": "moderator",
"protected": true,
"_updatedAt": "2026-11-07T02:22:08.408Z"
},
{
"_id": "680fc8d0825d98f164760591",
"name": "TOTP",
"scope": "Users",
"description": "TOTP",
"protected": false,
"mandatory2fa": true,
"_updatedAt": "2025-04-28T18:31:33.121Z"
}
],
"remove": [
{
"_id": "anonymous",
"__collection__": "roles",
"_deletedAt": "2026-10-27T19:31:44.643Z",
"_updatedAt": "2026-10-03T03:00:56.098Z",
"description": "",
"mandatory2fa": false,
"name": "anonymous",
"protected": true,
"scope": "Users"
}
]
},
"success": true
}Roles created or updated at or after the updatedSince date.
The role ID. For default roles, this is the same as the role name. For custom roles, this is a generated ID.
The role name.
Whether the role applies to the whole workspace (Users) or to rooms (Subscriptions).
The role description. Can be an empty string.
Whether users with this role must use two-factor authentication. This field is optional and can be missing from older roles.
Whether the role is a protected default role that can't be deleted.
The date the role was last updated.
Roles deleted after the updatedSince date.
The role ID.
The role name.
The collection the role was deleted from. Always roles.
The date the role was deleted.
The date the role was last updated before it was deleted.
Bad Request
{
"success": false,
"error": "updatedSince must be a valid date string [error-invalid-param]",
"errorType": "error-invalid-param"
}{
"success": false,
"error": "must NOT have additional properties",
"errorType": "error-invalid-params"
}Unauthorized
{
"success": false,
"error": "You must be logged in to do this."
}