wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add capabilities described by MSC3283 (#3614)

Browse source 
* Add capabilities described by MSC3283

MSC: https://github.com/matrix-org/matrix-doc/pull/3283

* changelog
This commit is contained in:
Travis Ralston 2022-01-04 20:28:42 -07:00 • committed by GitHub
parent e4057072bd
commit 0ee58100c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 74 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/3614.feature Normal file
View file

@ -0,0 +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).

73
content/client-server-api/_index.md
View file

@ -1293,6 +1293,79 @@ using an `unstable` version.
When this capability is not listed, clients should use `"1"` as the
default and only stable `available` room version.
### `m.set_displayname` capability
This capability has a single flag, `enabled`, to denote whether the user
is able to change their own display name via profile endpoints. Cases for
disabling might include users mapped from external identity/directory
services, such as LDAP.
Note that this is well paired with the `m.set_avatar_url` capability.
When not listed, clients should assume the user is able to change their
display name.
An example of the capability API's response for this capability is:
```json
{
"capabilities": {
"m.set_displayname": {
"enabled": false
}
}
}
```
### `m.set_avatar_url` capability
This capability has a single flag, `enabled`, to denote whether the user
is able to change their own avatar via profile endpoints. Cases for
disabling might include users mapped from external identity/directory
services, such as LDAP.
Note that this is well paired with the `m.set_displayname` capability.
When not listed, clients should assume the user is able to change their
avatar.
An example of the capability API's response for this capability is:
```json
{
"capabilities": {
"m.set_avatar_url": {
"enabled": false
}
}
}
```
### `m.3pid_changes` capability
This capability has a single flag, `enabled`, to denote whether the user
is able to add, remove, or change 3PID associations on their account. Note
that this only affects a user's ability to use the
[Admin Contact Information](#adding-account-administrative-contact-information)
API, not endpoints exposed by an Identity Service. Cases for disabling
might include users mapped from external identity/directory services,
such as LDAP.
When not listed, clients should assume the user is able to modify their 3PID
associations.
An example of the capability API's response for this capability is:
```json
{
"capabilities": {
"m.3pid_changes": {
"enabled": false
}
}
}
```
## Filtering
Filters can be created on the server and can be passed as a parameter to