User Roles Confused about "User Roles"?
Let us know how we can improve our documentation:
Confused about "User Roles"?
Let us know how we can improve our documentation:
- On This Page:
- User Roles
- Application User Roles
- Channel User Roles
User RolesCopied!Confused about "User Roles"?
Let us know how we can improve our documentation:
Confused about "User Roles"?
Let us know how we can improve our documentation:
Stream has user roles to control which permissions end-users and staff members of an application have can use. Stream provides default permissions for 5 different channel types, but these are customizable and custom channel types can be created through the dashboard. Permissions essentially amount to the features and endpoints that a user_id
has access to when accessing the Stream API.
Stream maintains a user role for each user_id at an Application level and a Channel level. This is to allow flexibility and to cover a wider range of use cases.
Application User RolesCopied!Confused about "Application User Roles"?
Let us know how we can improve our documentation:
Confused about "Application User Roles"?
Let us know how we can improve our documentation:
Role | Description | Permissions |
---|---|---|
Anonymous | Does not require a JWT and does not require a user_id registered with Stream | Lowest |
Guest | Does not require a JWT and has slightly higher permissions than Anonymous users | Low |
User | A registered user on the app with a JWT provided by a trusted source (server) | Normal |
Admin | A registered user with elevated permissions granted from a trusted source (server) | High |
Server-side | Not technically a user role. This is the client instantiated with the app key and secret. This is the highest level of administration and is run on the server | Highest |
Channel User RolesCopied!Confused about "Channel User Roles"?
Let us know how we can improve our documentation:
Confused about "Channel User Roles"?
Let us know how we can improve our documentation:
Roles | Description | Permissions |
---|---|---|
Watcher | Not a member of the channel but have limited permissions depending on the channel type. Status as a watcher does not persist from one logged-in session to another. | Low (channel type dependent) |
Member | A typical member of a channel. A more persistent association with a channel than a watcher. | Normal |
Moderator | Elevated permissions on a channel. Typically has the ability to edit/delete other user’s messages, for example. | High |
Admin | Admin application users are automatically admin’s on a channel and have elevated permissions. | Highest |