Skip to content

Commit ecf2ae2

Browse files
committed
Add capabilities described by MSC3283
MSC: #3283
1 parent 592cbd5 commit ecf2ae2

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

Diff for: content/client-server-api/_index.md

+73
Original file line numberDiff line numberDiff line change
@@ -1249,6 +1249,79 @@ using an `unstable` version.
12491249
When this capability is not listed, clients should use `"1"` as the
12501250
default and only stable `available` room version.
12511251

1252+
### `m.set_displayname` capability
1253+
1254+
This capability has a single flag, `enabled`, to denote whether the user
1255+
is able to change their own display name via profile endpoints. Cases for
1256+
disabling might include users mapped from external identity/directory
1257+
services, such as LDAP.
1258+
1259+
Note that this is well paired with the `m.set_avatar_url` capability.
1260+
1261+
When not listed, clients should assume the user is able to change their
1262+
display name.
1263+
1264+
An example of the capability API's response for this capability is:
1265+
1266+
```json
1267+
{
1268+
"capabilities": {
1269+
"m.set_displayname": {
1270+
"enabled": false
1271+
}
1272+
}
1273+
}
1274+
```
1275+
1276+
### `m.set_avatar_url` capability
1277+
1278+
This capability has a single flag, `enabled`, to denote whether the user
1279+
is able to change their own avatar via profile endpoints. Cases for
1280+
disabling might include users mapped from external identity/directory
1281+
services, such as LDAP.
1282+
1283+
Note that this is well paired with the `m.set_displayname` capability.
1284+
1285+
When not listed, clients should assume the user is able to change their
1286+
avatar.
1287+
1288+
An example of the capability API's response for this capability is:
1289+
1290+
```json
1291+
{
1292+
"capabilities": {
1293+
"m.set_avatar_url": {
1294+
"enabled": false
1295+
}
1296+
}
1297+
}
1298+
```
1299+
1300+
### `m.3pid_changes` capability
1301+
1302+
This capability has a single flag, `enabled`, to denote whether the user
1303+
is able to add, remove, or change 3PID associations on their account. Note
1304+
that this only affects a user's ability to use the
1305+
[Admin Contact Information](#adding-account-administrative-contact-information)
1306+
API, not endpoints exposed by an Identity Service. Cases for disabling
1307+
might include users mapped from external identity/directory services,
1308+
such as LDAP.
1309+
1310+
When not listed, clients should assume the user is able to modify their 3PID
1311+
associations.
1312+
1313+
An example of the capability API's response for this capability is:
1314+
1315+
```json
1316+
{
1317+
"capabilities": {
1318+
"m.3pid_changes": {
1319+
"enabled": false
1320+
}
1321+
}
1322+
}
1323+
```
1324+
12521325
## Filtering
12531326

12541327
Filters can be created on the server and can be passed as a parameter to

0 commit comments

Comments
 (0)