Overview

Stream Chat ships with a configurable permission system that allows high resolution control over what users are permitted to do. There are two versions available, so before diving into the documentation, it is important to understand which version of permissions you are using :

// To check your permissions version (server side only)
const { app } = await client.getAppSettings();
console.log(app.permission_version);

// To check your permissions version (server side only)
$response = $client->getAppSettings();
var_dump($response['app']['permission_version']); // "v1" or "v2"

# To check your permissions version (server side only)
response = client.get_app_settings()
print(response["app"]["permission_version"]) # "v1" or "v2"

// To check your permissions version (server side only)
var app = App.get().request();
System.out.println(app.getApp().getPermissionVersion()); // "v1" or "v2"

# require 'stream-chat'

# To check your permissions version (server side only)
response = client.get_app_settings
puts response['app']['permission_version'] # "v1" or "v2"

// To check your permissions version (server side only)
conf, _ := c.GetAppConfig(ctx)
fmt.Print(conf.App.PermissionVersion)

// To check your permissions version (server side only)
var result = await appClient.GetAppSettingsAsync();
Console.WriteLine(result.App.PermissionVersion); // enum of PermissionVersion.V1 or PermissionVersion.V2

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

Based on your version and use case, pick a page to learn more:

1. Permissions v1

2. Permissions v2

3. Migrating from Legacy

4. Multi-Tenancy - grouping users into teams (or tenants) to keep their data strictly segregated.