Skip to content

Commit 0ee5810

Browse files
authored
Add capabilities described by MSC3283 (#3614)
* Add capabilities described by MSC3283 MSC: #3283 * changelog
1 parent e405707 commit 0ee5810

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

Diff for: changelogs/client_server/newsfragments/3614.feature

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add new `m.set_displayname`, `m.set_avatar_url`, and `m.3pid_changes` capabilities as per [MSC3283](https://github.com/matrix-org/matrix-doc/pull/3283).

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

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

1296+
### `m.set_displayname` capability
1297+
1298+
This capability has a single flag, `enabled`, to denote whether the user
1299+
is able to change their own display name via profile endpoints. Cases for
1300+
disabling might include users mapped from external identity/directory
1301+
services, such as LDAP.
1302+
1303+
Note that this is well paired with the `m.set_avatar_url` capability.
1304+
1305+
When not listed, clients should assume the user is able to change their
1306+
display name.
1307+
1308+
An example of the capability API's response for this capability is:
1309+
1310+
```json
1311+
{
1312+
"capabilities": {
1313+
"m.set_displayname": {
1314+
"enabled": false
1315+
}
1316+
}
1317+
}
1318+
```
1319+
1320+
### `m.set_avatar_url` capability
1321+
1322+
This capability has a single flag, `enabled`, to denote whether the user
1323+
is able to change their own avatar via profile endpoints. Cases for
1324+
disabling might include users mapped from external identity/directory
1325+
services, such as LDAP.
1326+
1327+
Note that this is well paired with the `m.set_displayname` capability.
1328+
1329+
When not listed, clients should assume the user is able to change their
1330+
avatar.
1331+
1332+
An example of the capability API's response for this capability is:
1333+
1334+
```json
1335+
{
1336+
"capabilities": {
1337+
"m.set_avatar_url": {
1338+
"enabled": false
1339+
}
1340+
}
1341+
}
1342+
```
1343+
1344+
### `m.3pid_changes` capability
1345+
1346+
This capability has a single flag, `enabled`, to denote whether the user
1347+
is able to add, remove, or change 3PID associations on their account. Note
1348+
that this only affects a user's ability to use the
1349+
[Admin Contact Information](#adding-account-administrative-contact-information)
1350+
API, not endpoints exposed by an Identity Service. Cases for disabling
1351+
might include users mapped from external identity/directory services,
1352+
such as LDAP.
1353+
1354+
When not listed, clients should assume the user is able to modify their 3PID
1355+
associations.
1356+
1357+
An example of the capability API's response for this capability is:
1358+
1359+
```json
1360+
{
1361+
"capabilities": {
1362+
"m.3pid_changes": {
1363+
"enabled": false
1364+
}
1365+
}
1366+
}
1367+
```
1368+
12961369
## Filtering
12971370

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

0 commit comments

Comments
 (0)