Permissions v2

Before You Start

Make sure that your application has version 2 of permissions enabled. In order to do that, follow this guide first.

Getting Started

There are multiple important terms to understand when it comes to permission management. Each permission check comes down to three things:

Subject - an actor which attempts to perform certain Action. It could be represented by a User or by a ChannelMember
Resource - an item that Subject attempts to perform an Action against. It could be a Channel, Message, Attachment or another User
Action - the exact action that is being performed. For example CreateChannel, DeleteMessage, AddLinks

The purpose of permission system is to answer a question: is Subject A allowed to perform Action B on Resource C ?

Stream Chat provides several concepts which help to control which actions are available to whom:

Permission - an object which represents actions a subject is allowed to perform
Role - assigned to a User or Channel Member and is used to check their permissions
Grants - the way permissions are assigned to roles, applicable across the entire application, or specific to a single channel type or channel.

Also important to know is permissions checking only happens on the client-side calls. Server-side allows everything so long as a valid API key and secret is provided.

To make it easy to get started, all Stream applications come with several roles already built in with permissions to represent the most common use cases. These roles can be customized if needed, and new roles can be created specific for your application

This is the process of assigning a role to users so they can be granted permissions. This represents Subject A in the permissions question. Users will have one role which grants them permissions for the entire application and additionally users can have channel roles which grant permissions for a single channel or for all channels with the same channel type.

By default all users have builtin role user assigned. To change the role of the User, you can use UpdateUser API endpoint:

await client.partialUpdateUser({
  id: "james_bond",
  set: { role: "special_agent" },
});

$client->partialUpdateUsers([
 'id' => 'james_bond',
 'set' => [
  'role' => 'special_agent',
 ],
])

response = client.update_user_partial(
 {"id": "james_bond", "set": {"role": "special_agent"}}
)

var reqObj =
  UserPartialUpdateRequestObject.builder()
    .id("james_bond")
    .setValue("role", "special_agent")
    .build();
var resp = User.partialUpdate().user(reqObj).request());

var upsertResponse = await _userClient.UpdatePartialAsync(new UserPartialRequest
{
    Id = "user-id",
    Set = new Dictionary<string, object>
    {
        { "role", "special_agent" }
    }
});

# require 'stream-chat'

client.update_user_partial({
  id: 'james_bond',
  set: { role: 'special_agent' }
 })

update := PartialUserUpdate{
	ID: "james_bond",
	Set: map[string]interface{}{
		"role": "special_agent",
	},
}
resp, err := c.PartialUpdateUser(ctx, update)

// This is a server-side only feature, choose any of our server-side SDKs to use it

Once you add user to the channel, channel_member role will be assigned to user’s membership:

const result = await channel.addMembers([{ user_id: "james_bond" }]);
console.log(result.members[0].channel_role); // "channel_member"

$result = $channel->addMembers([
 ['user_id' => 'james_bond'],
]);
var_dump($result['members'][0]['channel_role']); // "channel_member"

result = channel.add_members([{"user_id": "james_bond"}])
print(result["members"][0]["channel_role"])

var resp = Channel.update("chanel_type", "channel_id")
				 .addMember("james_bond")
				 .request();
System.out.println(resp.getMembers().get(0).getRole());

var addMembersResponse
    = await _channelClient.AddMembersAsync("channel-type", "channel-id", new[] { "user-id" });
Console.WriteLine(addMembersResponse.Members[0].ChannelRole); // channel role is equal to "channel_member"

resp = channel.add_members(['james_bond'])
puts resp['members'][0]['channel_role']

_, err = ch.AddMembers(ctx, []string{"james_bond"}, nil, nil)

// This is a server-side only feature, choose any of our server-side SDKs to use it

In order to change channel-level role of the user, you can either add user to the channel with a different role (if the SDK supports it) or update it later by role assignment:

// Add user to the channel with role set
await channel.addMembers([
  { user_id: "james_bond", channel_role: "channel_moderator" },
]);
// Assign new channel member role
await channel.assignRoles([
  { user_id: "james_bond", channel_role: "channel_member" },
]);

// Add user to the channel with role set
$result = $channel->addMembers([
 ['user_id' => 'james_bond', 'channel_role' => 'channel_moderator'],
]);

// Assign new channel member role
$result = $channel->assignRoles([
 ['user_id' => 'james_bond', 'channel_role' => 'channel_member'],
]);

# Add user to the channel with role set
result = channel.add_members([{"user_id": "james_bond", "channel_role": "channel_moderator"}])

# Assign new channel member role
result = channel.assign_roles([{"user_id": "james_bond", "channel_role": "channel_member"}])

var assignment = new RoleAssignment();
assignment.setChannelRole("channel_member");
assignment.setUserId("james_bond");

Channel.assignRoles(channel.getType(), channel.getId())
        .assignRole(assignment)
        .request();

// User must be a member of the channel before you can assign channel role
var resp = await _channelClient.AssignRolesAsync("channel-type", "channel-id", new AssignRoleRequest
{
    AssignRoles = new List<RoleAssignment>
    {
        new RoleAssignment { UserId = "user-id", ChannelRole = Role.ChannelModerator }
    }
});

# Add user to the channel with role set
channel.add_members([{'user_id' => 'james_bond', 'channel_role' => 'channel_moderator'}])

# Assign new channel member role
channel.assign_roles([{'user_id' => 'james_bond', 'channel_role' => 'channel_moderator'}])

a := []*RoleAssignment{{ChannelRole: "channel_moderator", UserID: "james_bond"}}
resp, err = ch.AssignRole(ctx, a, nil)

// This is a server-side only feature, choose any of our server-side SDKs to use it

changing channel member roles is not allowed client-side.

Subject

Subject can be represented by User or ChannelMember. ChannelMember subject is used only when user interacts with a channel that they are member of. Both User and ChannelMember have Role and permission system takes both roles into consideration when checking permissions.

Builtin roles

There are some builtin roles in Stream Chat that cover basic chat scenarios:

Role	Level	Description
user	User	Default User role
guest	User	Used for guest users created by server-side endpoints. Guests are short-lived temporary users that could be created without a token
anonymous	User	Anonymous users are not allowed to perform any actions that write data. You should treat them as unathenticated clients
admin	User	Role for users that perform administrative tasks with elevated permissions
channel_member	Channel	Default role that gets assigned when user is added to the channel
channel_moderator	Channel	Role for channel members that perform administrative tasks with elevated permissions

It’s worth noting that you cannot use user-level roles as channel-level roles vice-versa. This restriction only applies to builtin roles

Ownership

Some Stream Chat entities have an owner and the fact of ownership can be considered when configuring access permissions. Ownership is supported in these entity types:

Channel - owned by its creator
Message - owned by its creator (sender)
Attachment - owned by user who uploaded a file
User - authenticated user owns itself

Using ownership concept, permissions could be set up in such a way that allows entity owners to perform certain actions. For example:

Update Own Message - allows message senders to edit their messages
Update Own User - allows users to change their own properties (except role and team)
Send Message in Own Channel - allows channel creators to send messages in the channels that they created even if they are not members

Custom Roles

In more sophisticated scenarios custom roles could be used. One Stream Chat application could have up to 25 custom roles. Roles are simple, and require only a name to be created. They do nothing until permissions are assigned to the role. To create new custom role you can use CreateRole API endpoint:

await client.createRole("special_agent");

$client->createRole('special_agent');

client.create_role("special_agent")

Role.create().name("special_agent").request()

await _permissionClient.CreateRoleAsync("special_agent");

client.create_role('special_agent')

p := client.Permissions()
p.CreateRole(ctx, "special_agent")

// This is a server-side only feature, choose any of our server-side SDKs to use it

To delete previously created role you can use DeleteRole API endpoint:

await client.deleteRole("agent_006");

$client->deleteRole('agent_006');

client.delete_role("agent_006")

Role.delete("agent_006").request());

await _permissionClient.DeleteRoleAsync("special_agent");

client.delete_role('agent_006')

p := client.Permissions()
p.DeleteRole(ctx, "agent_006")

// This is a server-side only feature, choose any of our server-side SDKs to use it

In order to delete a role, you have to remove all permission grants that this role has and make sure that you don’t have non-deleted users with this role assigned. Channel-level roles could be deleted without reassigning them, although, some users could lose access to channels where this role is used.

Once you have a role created you can start granting permissions to it. You can also grant or remove permissions for built in roles.

Granting permissions

User access in Chat application is split across multiple scopes.

Application Permissions : You can grant these using the.app scope. These permissions apply to operations that occur outside of channel-types including accessing and modifying other users, or using moderation features.
Channel-Type Permissions : These apply permissions to all channels of a particular type.
Channel Permissions : These apply permissions to a single channel and override channel-type permissions.

To list all available permissions you can you ListPermissions API endpoint:

const { permissions } = await client.listPermissions(); // List of Permission objects

$response = $client->listPermissions();
var_dump($response['permissions']); // List of Permissions objects

response = client.list_permissions()

var response = Permission.list().request();

var response = await _permissionClient.ListPermissionsAsync();

response = client.list_permissions

resp, err := p.ListPermissions(ctx)

// This is a server-side only feature, choose any of our server-side SDKs to use it

You can also find all available permissions on Permissions Reference page

Each permission object contains these fields:

Type	Description	Description	Example
id	string	Unique permission ID	create-message-owner
name	string	Human-readable permission name	Create Message in Owned Channel
description	string	Human-readable permission description	Grants action CreateMessage which allows to send a new message, user should own a channel
action	string	Action which this permission grants	CreateMessage
owner	boolean	If true, Subject should be an owner of the Resource	true
same_team	boolean	If true, Subject should be a part of the team that Resource is a part of	true

To manipulate granted permissions for certain channel type, you can use UpdateChannelType API endpoint:

// observe current grants of the channel type
const { grants } = await client.getChannelType("messaging");

// update "channel_member" role grants in "messaging" scope
await client.updateChannelType("messaging", {
  grants: {
    channel_member: [
      "read-channel", // allow access to the channel
      "create-message", // create messages in the channel
      "update-message-owner", // update own user messages
      "delete-message-owner", // delete own user messages
    ],
  },
});

// observe current grants of the channel type
$response = $client->getChannelType('messaging');
var_dump($response['grants']);

// update "channel_member" role grants in "messaging" scope
$client->updateChannelType('messaging', [
 'grants' => [
  'channel_member' => [
   "read-channel",     // allow access to the channel
   "create-message",    // create messages in the channel
   "update-message-owner", // update own user messages
   "delete-message-owner", // delete own user messages
  ],
 ],
]);

# observe current grants of the channel type
response = client.get_channel_type("messaging")
print(repr(response["grants"]))

# update "channel_member" role grants in "messaging" scope
client.update_channel_type("messaging", grants={
 "channel_member": [
  "read-channel",     # allow access to the channel
  "create-message",    # create messages in the channel
  "update-message-owner", # update own user messages
  "delete-message-owner", # delete own user messages
 ]
})

// observe current grants of the channel type
var response = ChannelType.get("messaging").request();
System.out.println(response.getGrants());

// update "channel_member" role grants in "messaging" scope
var grants = new HashMap<string, List<String>>();
grants.put("channel_member", List.of(
  "read-channel",     // allow access to the channel
  "create-message",    // create messages in the channel
  "update-message-owner", // update own user messages
  "delete-message-owner" // delete own user messages
));

ChannelType.update("messaging").grants(grants).request();

// observe current grants of the channel type
var channelType = await _channelTypeClient.GetChannelTypeAsync("messaging");
Console.WriteLine(channelType.Grants);

// update "channel_member" role grants in "messaging" scope
var update = new ChannelTypeWithStringCommandsRequest
{
    Grants = new Dictionary<string, List<string>>
    {
        {
            // This will replace all existing grants of "channel_member" role
            "channel_member", new List<string>
            {
                "read-channel", // allow access to the channel
                "create-message", // create messages in the channel
                "update-message-owner", // update own user messages
                "delete-message-owner", // delete own user messages
            }
        },
    }
};
await _channelTypeClient.UpdateChannelTypeAsync("messaging", update);

# observe current grants of the channel type
response = client.get_channel_type('messaging')
puts response['grants']

# update "channel_member" role grants in "messaging" scope
client.update_channel_type('messaging', grants: { 'channel_member' => [
  'read-channel', # allow access to the channel
  'create-message', # create messages in the channel
  'update-message-owner', # update own user messages
  'delete-message-owner', # delete own user messages
 ]})

// observe current grants of the channel type
resp, err := c.GetChannelType(ctx, ct.Name)
fmt.Print(resp.Grants)

// update "channel_member" role grants in "messaging" scope
resp, err = client.UpdateChannelType(ctx, "messaging", map[string]interface{}{
	"grants": map[string][]string{
		"channel_member": {
			"read-channel",     // allow access to the channel
			"create-message",    // create messages in the channel
			"update-message-owner", // update own user messages
			"delete-message-owner", // delete own user messages
		},
	},
})

// This is a server-side only feature, choose any of our server-side SDKs to use it

This call will only change grants of roles that were mentioned in the request. You can remove all role grants with providing empty array ( [] ) as list of granted permissions:

await client.updateChannelType("messaging", {
  grants: {
    guest: [], // removes all grants of "guest" role
    anonymous: [], // removes all grants of "anonymous" role
  },
});

$client->updateChannelType('messaging', [
 'grants' => [
  'guest' => [],   // removes all grants of "guest" role
  'anonymous' => [], // removes all grants of "anonymous" role
 ],
]);

client.update_channel_type("messaging", grants={
 "guest": [], # removes all grants of "guest" role
 "anonymous": [], # removes all grants of "anonymous" role
})

var grants = new HashMap<string, List<String>>();
grants.put("guest", Collections.emptyList()); // removes all grants of "guest" role
grants.put("anonymous", Collections.emptyList()); // removes all grants of "anonymous" role

ChannelType.update("messaging").grants(grants).request();

var update = new ChannelTypeWithStringCommandsRequest
{
    Grants = new Dictionary<string, List<string>>
    {
        { "guest", new List<string>() }, // removes all grants of "guest" role
        { "anonymous", new List<string>() }, // removes all grants of "anonymous" role
    }
};
await _channelTypeClient.UpdateChannelTypeAsync("messaging", update);

client.update_channel_type('messaging', grants: {
 'guest' => [], # removes all grants of "guest" role
 'anonymous' => [] # // removes all grants of "anonymous" role
})

resp, err = client.UpdateChannelType(ctx, "messaging", map[string]interface{}{
	"grants": map[string][]string{
		"anonymous": {}, // removes all grants of "guest" role
		"guest":   {}, // removes all grants of "anonymous" role
	},
})

// This is a server-side only feature, choose any of our server-side SDKs to use it

If you want to reset the whole scope to default settings, you can explicitly provide null to grants field:

await client.updateChannelType("messaging", {
  grants: null, // resets the whole scope to default settings
});

$client->updateChannelType('messaging', [
 'grants' => null, // resets the whole scope to default settings
]);

# reset the whole scope to default settings
client.update_channel_type("messaging", grants=None)

ChannelType.update("messaging").grants(Collections.emptyMap()).request();

var update = new ChannelTypeWithStringCommandsRequest
{
    Grants = new Dictionary<string, List<string>>()
};
await _channelTypeClient.UpdateChannelTypeAsync("messaging", update);

client.update_channel_type('messaging', grants: nil)

resp, err = client.UpdateChannelType(ctx, "messaging", map[string]interface{}{
	"grants": nil,
})

// This is a server-side only feature, choose any of our server-side SDKs to use it

You can manipulate .app scope grants using UpdateApp API endpoint in exactly the same way:

// update grants of multiple roles in ".app" scope
await client.updateApp({
  grants: {
    anonymous: [],
    guest: [],
    user: ["search-user", "mute-user"],
    admin: ["search-user", "mute-user", "ban-user"],
  },
});

// update grants of multiple roles in ".app" scope
$client->updateApp([
 'grants' => [
  'anonymous' => [],
  'guest' => [],
  'user' => [
   "search-user",
   "mute-user",
  ],
  'admin' => [
   "search-user",
   "mute-user",
   "ban-user",
  ],
 ]
])

# update grants of multiple roles in ".app" scope
client.update_app_settings(grants={
 "anonymous": [],
 "guest": [],
 "user": [
  "search-user",
  "mute-user",
 ],
 "admin": [
  "search-user",
  "mute-user",
  "ban-user",
 ],
})

var grants = new HashMap<String, List<String>>();
grants.put("anonymous", Collections.emptyList());
grants.put("guest", Collections.emptyList());
grants.put("user", List.of("search-user", "mute-user"));
grants.put("admin", List.of("search-user", "mute-user", "ban-user"));

App.update().grants(grants).request();

var settings = new AppSettingsRequest
{
    Grants = new Dictionary<string, List<string>>
    {
        { "anonymous", new List<string>() },
        { "guest", new List<string>() },
        { "user", new List<string> { "search-user", "mute-user" } },
        { "admin", new List<string> { "search-user", "mute-user", "ban-user" } },
    }
};
await _appClient.UpdateAppSettingsAsync(settings);

client.update_app_settings(grants: {
 'anonymous' => [],
 'guest' => [],
 'user' => ['search-user', 'muter-user'],
 'admin' => ['search-user', 'muter-user', 'ban-user'],
})

grants := map[string][]string{
	"anonymous": {},
	"guest":   {},
	"user":   {"search-user", "muter-user"},
	"admin":   {"search-user", "muter-user", "ban-user"},
}
settings := NewAppSettings().SetGrants(grants)

resp, err := c.UpdateAppSettings(ctx, settings)

// This is a server-side only feature, choose any of our server-side SDKs to use it

UI for configuring permissions

Stream Dashboard provides a user interface to edit permission grants. This UI is available on Chat > Roles & Permissions page which is available after switching to version 2 of permissions.

Channel-level permissions

In some cases it makes sense to slightly modify granted permissions for the channel without changing channel-type grants configuration. For this, you can use Grants Modifiers that you can set for each channel individually. Grants Modifiers look almost exactly the same as regular Grants object except it allows to revoke permissions as well as grant new ones. For example, if we want to disallow sending links for users with role “user” in channel “livestream:example” and allow creating reactions, we can do this:

await channel.updatePartial({
  set: {
    config_overrides: {
      grants: {
        user: ["!add-links", "create-reaction"],
      },
    },
  },
});

$channel->updatePartial([
 'set' => [
  'config_overrides' => [
   'grants' => [
    'user' => ["!add-links", "create-reaction"],
   ],
  },
 },
})

channel.update_partial(to_set={
 "config_overrides": {
  "grants": {
   "user": ["!add-links", "create-reaction"],
  }
 }
})

Map<String, Object> grants = new HashMap<>();
Map<String, Object> overrides = new HashMap<>();
grants.put("user", List.of("!add-links", "create-reaction"));
overrides.put("grants", grants);

Channel.partialUpdate(channel.getType(), channel.getId())
          .setValue("config_overrides", overrides)
          .request()

var grants = new Dictionary<string, object> { { "user", new List<string> { "!add-links", "create-reaction" } } };
var overrides = new Dictionary<string, object> { { "grants", grants } };
var request = new PartialUpdateChannelRequest
{
    Set = new Dictionary<string, object>
    {
        { "config_overrides", overrides }
    }
};
var resp = await _channelClient.PartialUpdateAsync("channel-type", "channel-id", request);

channel.update_partial({ 'config_overrides' => { 'grants' => { 'user' => ['!add-links', 'create-reaction'] } } })

_, err = ch.PartialUpdate(ctx, PartialUpdate{
	Set: map[string]interface{}{
		"config_overrides": map[string]interface{}{
			"grants": map[string]interface{}{
				"user": []string{"!add-links", "create-reaction"},
			},
		},
	},
})

// This is a server-side only feature, choose any of our server-side SDKs to use it

Exclamation mark ( ! ) here means “revoke” and you can combine any number of “revoke” and “grant” modifiers

After modifying the granted channel-level permissions, the API will enrich the channel response with the grants field under data.config.grants

The field config_overrides can only be updated using server-side auth

Broadcast and Reply-only Channels

A common example of changing the permission model of a channel type is to create a Telegram-style broadcast channel where privileged channel members can send messages and other members may have permissions restricted to reading, reactions, or replying.

The three Permission grants to modify these under the scope of the channel type are

Read Channel
Create Reaction
Create Reply

Permissions v1 (legacy)

Reference