The Programmable Chat Permission model uses
Permissions to enforce what Users and Members can do within a Service instance. These permissions are related to
Messages. Roles and their associated permissions can be edited and extended on a per Service instance basis to meet the needs of different use cases.
Table of Contents
Chat Roles are divided into two "Scopes," Service and Channel. These determine how the Role permissions are applied depending on the context.
- Service level Roles are assigned to Users and dictate which Channels the User can see, join, and create.
- Channel level Roles are assigned to Members within a Channel. These roles determine what Members can do within that Channel, such as send Messages, add other Members, edit Messages and more.
Permissions are enforced at runtime based on the action being performed and whether the User/Member's Role has the required Permissions. If they do, the action is allowed and will be processed. If not, the action will be disallowed, and an error message will be returned to the requesting endpoint (usually a 403 Permission Denied error).
Note: Chat Service instances are created with a default set of Roles and Permissions. You can modify and extend these Roles and their assigned Permissions via the REST API.
When a new Chat Service instance is created, the following default Roles are created with the assigned set of Permissions:
|Service User (Default Service User Role)||deployment||
|Channel User (Default Channel Member Role)||channel||
It is possible to manage Roles within a Service instance, create new ones, modify Permissions for a Role, and more via the Roles REST endpoint. The following roles and permissions management best practices will help you to setup needed roles for the newly created or invited users.
- When you create a User you must pick a Service Role, if you have not created your own Service Role, you must choose whether they are a Service User, or a Service Admin.
- When you invite a User to a Channel, they become a member and the Channel Role they receive is an optional parameter in the invite. Alternatively, you can add the optional Channel Role while Creating a Channel Member by adding the member using the Identity of the User.
You can also create your own Service and Channel Roles if the defaults do not suit you. We recommend leaving the default roles untouched. To see the full list of permissions available please follow this link.
You can find more information on how to do this in our Programmable Chat Roles REST Resource
Please note that we plan to add managing Roles to the Chat Console in the near future.
Note: While it is possible to delete the default Roles, it is not advisable, as any Users and Members created before the delete will reference the Default Role SIDs. Instead, modify these roles and reuse them, adding new Roles as needed.
Next: Typing Indicator