Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-23 06:23:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add profile_fields capability and deprecations into text section

Browse source 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2025-07-31 13:53:55 +02:00
parent 569c8aafa3
commit d60c847314
1 changed files with 62 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2491,8 +2491,59 @@ using an `unstable` version.
When this capability is not listed, clients should use `"1"` as the When this capability is not listed, clients should use `"1"` as the
default and only stable `available` room version. default and only stable `available` room version.
### `m.profile_fields` capability
This capability has a flag, `enabled`, and two lists, `allowed` and
`disallowed`, that together denote which fields the user is able to
change via the profile endpoints.
When `enabled` is `false`, all profile fields are managed by the server
and the client is not permitted to make any changes.
When `enabled` is `true`, clients are permitted to modify profile fields,
subject to the restrictions implied by the OPTIONAL lists `allowed` and
`disallowed`. If only `allowed` is present, clients can modify all
contained fields but SHOULD assume all other fields to be managed by
the server. Contrarily, if only `disallowed` is present, clients are
unable to modify any contained fields but SHOULD assume all other fields
to be unmanaged. If both `allowed` and `disallowed` are specified,
`allowed` takes precendece. This means clients can modify all fields
in `allowed` but none of the fields in `disallowed` unless they also
occur in `allowed`. If neither `allowed` nor `disallowed` is present,
clients can modify all fields without restrictions.
When not listed, clients SHOULD assume the user is able to change
profile fields without any restrictions, provided the homeserver
advertises a specification version that includes the `m.profile_fields`
capability in the [`/versions`](/client-server-api/#get_matrixclientversions)
response.
An example of the capability API's response for this capability is:
```json
{
"capabilities": {
"m.profile_fields": {
"enabled": true,
"disallowed": ["displayname"]
}
}
}
```
### `m.set_displayname` capability ### `m.set_displayname` capability
{{% boxes/note %}}
{{% changed-in v="1.16" %}}
This capability is now deprecated. Clients SHOULD use the
[`m.profile_fields`](/client-server-api/#mprofile_fields-capability)
capability instead.
For backwards compatibility, servers that directly or indirectly include
the `displayname` profile field in the `m.profile_fields` capability
MUST still set this capability accordingly.
{{% /boxes/note %}}
This capability has a single flag, `enabled`, to denote whether the user 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 is able to change their own display name via profile endpoints. Cases for
disabling might include users mapped from external identity/directory disabling might include users mapped from external identity/directory
@ -2517,6 +2568,17 @@ An example of the capability API's response for this capability is:
### `m.set_avatar_url` capability ### `m.set_avatar_url` capability
{{% boxes/note %}}
{{% changed-in v="1.16" %}}
This capability is now deprecated. Clients SHOULD use the
[`m.profile_fields`](/client-server-api/#mprofile_fields-capability)
capability instead.
For backwards compatibility, servers that directly or indirectly include
the `avatar_url` profile field in the `m.profile_fields` capability
MUST still set this capability accordingly.
{{% /boxes/note %}}
This capability has a single flag, `enabled`, to denote whether the user This capability has a single flag, `enabled`, to denote whether the user
is able to change their own avatar via profile endpoints. Cases for is able to change their own avatar via profile endpoints. Cases for
disabling might include users mapped from external identity/directory disabling might include users mapped from external identity/directory