Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-28 22:14:10 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

get_profile_clarify_authentication_config

Browse source 
Signed-off-by: Harishankar Kumar <hari01584@gmail.com>
This commit is contained in:
Harishankar Kumar 2023-02-22 17:47:16 +05:30
parent 71b2235868
commit bd3ea9f6cd
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
data/api/client-server/profile.yaml
View file

@ -185,6 +185,8 @@ paths:
to fetch the user's own profile information or other users; either to fetch the user's own profile information or other users; either
locally or on remote homeservers. This API may return keys which are not locally or on remote homeservers. This API may return keys which are not
limited to `displayname` or `avatar_url`. limited to `displayname` or `avatar_url`.
_Please note that access token is required if require_auth_for_profile_requests is true [in configuration](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#require_auth_for_profile_requests)._
operationId: getUserProfile operationId: getUserProfile
parameters: parameters:
- in: path - in: path
@ -211,6 +213,15 @@ paths:
displayname: displayname:
type: string type: string
description: The user's display name if they have set one, otherwise not present. description: The user's display name if they have set one, otherwise not present.
401:
description: The access token is not provided or is invalid.
examples:
application/json: {
"errcode": "M_MISSING_TOKEN",
"error": "Missing access token"
}
schema:
"$ref": "definitions/errors/error.yaml"
403: 403:
x-addedInMatrixVersion: "1.2" x-addedInMatrixVersion: "1.2"
description: The server is unwilling to disclose whether the user exists and/or has profile information. description: The server is unwilling to disclose whether the user exists and/or has profile information.