Links
Comment on page

Get Permissions

List all the permissions in this workspace. Each permission is associated with a role. You can use this information to customize your UI based on user permissions.
Name
Requires Auth
Permission
Setting
permissions/get
Yes

Example Call

{
"msg": "method",
"method": "sendMessage",
"id": "423",
"params": [
{
"_id": "8gMsLe9A7pZjo2D2iB",
"rid": "64a1f373376181965ab77f54",
"msg": "Hello World!"
}
]
}

Example Response

{
"msg": "result",
"id": "442",
"result": [
{
"_id": "access-permissions",
"_updatedAt": {
"$date": 1688334885629
},
"roles": [
"admin"
]
},
{
"_id": "access-setting-permissions",
"_updatedAt": {
"$date": 1688334885660
},
"roles": [
"admin"
]
},
{
"_id": "add-oauth-service",
"_updatedAt": {
"$date": 1688334885667
},
"roles": [
"admin"
]
},
{
"_id": "add-user-to-joined-room",
"_updatedAt": {
"$date": 1688334885673
},
"roles": [
"admin",
"owner",
"moderator"
]
},
{
"_id": "add-user-to-any-c-room",
"_updatedAt": {
"$date": 1688334885682
},
"roles": [
"admin"
]
}
}

The Permission object

The permission object describes permission as:
  • _id: The permission's id
  • roles: A collection of roles that this permission applies to
  • _updatedAt: (Optional) The last time this permission object was updated in the database
  • meta: Metadata about the permission (described below)
  • $loki: An internal property that can be ignored (it is removed on the web client before being added to the web client's database)
Last modified 5mo ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.