You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
273 lines
8.8 KiB
YAML
273 lines
8.8 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
openapi: 3.1.0
|
|
info:
|
|
title: Matrix Client-Server Profile API
|
|
version: 1.0.0
|
|
paths:
|
|
"/profile/{userId}/displayname":
|
|
put:
|
|
summary: Set the user's display name.
|
|
description: |-
|
|
This API sets the given user's display name. You must have permission to
|
|
set this user's display name, e.g. you need to have their `access_token`.
|
|
operationId: setDisplayName
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user whose display name to set.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
example: {
|
|
"displayname": "Alice Margatroid"
|
|
}
|
|
properties:
|
|
displayname:
|
|
type: string
|
|
description: The new display name for this user.
|
|
description: The new display name information.
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: The display name was set.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object # empty json object
|
|
examples:
|
|
response:
|
|
value: {}
|
|
"429":
|
|
description: This request was rate-limited.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: definitions/errors/rate_limited.yaml
|
|
tags:
|
|
- User data
|
|
get:
|
|
summary: Get the user's display name.
|
|
description: |-
|
|
Get the user's display name. This API may be used to fetch the user's
|
|
own displayname or to query the name of other users; either locally or
|
|
on remote homeservers.
|
|
operationId: getDisplayName
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user whose display name to get.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: The display name for this user.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
displayname:
|
|
type: string
|
|
description: The user's display name if they have set one, otherwise not
|
|
present.
|
|
examples:
|
|
response:
|
|
value: {
|
|
"displayname": "Alice Margatroid"
|
|
}
|
|
"404":
|
|
description: There is no display name for this user or this user does not exist.
|
|
tags:
|
|
- User data
|
|
"/profile/{userId}/avatar_url":
|
|
put:
|
|
summary: Set the user's avatar URL.
|
|
description: |-
|
|
This API sets the given user's avatar URL. You must have permission to
|
|
set this user's avatar URL, e.g. you need to have their `access_token`.
|
|
operationId: setAvatarUrl
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user whose avatar URL to set.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
example: {
|
|
"avatar_url": "mxc://matrix.org/wefh34uihSDRGhw34"
|
|
}
|
|
properties:
|
|
avatar_url:
|
|
type: string
|
|
format: uri
|
|
description: The new avatar URL for this user.
|
|
description: The new avatar information.
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: The avatar URL was set.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object # empty json object
|
|
examples:
|
|
response:
|
|
value: {}
|
|
"429":
|
|
description: This request was rate-limited.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: definitions/errors/rate_limited.yaml
|
|
tags:
|
|
- User data
|
|
get:
|
|
summary: Get the user's avatar URL.
|
|
description: |-
|
|
Get the user's avatar URL. This API may be used to fetch the user's
|
|
own avatar URL or to query the URL of other users; either locally or
|
|
on remote homeservers.
|
|
operationId: getAvatarUrl
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user whose avatar URL to get.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: The avatar URL for this user.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
avatar_url:
|
|
type: string
|
|
format: uri
|
|
description: The user's avatar URL if they have set one, otherwise not present.
|
|
examples:
|
|
response:
|
|
value: {
|
|
"avatar_url": "mxc://matrix.org/SDGdghriugerRg"
|
|
}
|
|
"404":
|
|
description: There is no avatar URL for this user or this user does not exist.
|
|
tags:
|
|
- User data
|
|
"/profile/{userId}":
|
|
get:
|
|
summary: Get this user's profile information.
|
|
description: |-
|
|
Get the combined profile information for this user. This API may be used
|
|
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
|
|
limited to `displayname` or `avatar_url`.
|
|
operationId: getUserProfile
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user whose profile information to get.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: The profile information for this user.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
avatar_url:
|
|
type: string
|
|
format: uri
|
|
description: The user's avatar URL if they have set one, otherwise not present.
|
|
displayname:
|
|
type: string
|
|
description: The user's display name if they have set one, otherwise not
|
|
present.
|
|
examples:
|
|
response:
|
|
value: {
|
|
"avatar_url": "mxc://matrix.org/SDGdghriugerRg",
|
|
"displayname": "Alice Margatroid"
|
|
}
|
|
"403":
|
|
x-addedInMatrixVersion: "1.2"
|
|
description: The server is unwilling to disclose whether the user exists and/or
|
|
has profile information.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: definitions/errors/error.yaml
|
|
examples:
|
|
response:
|
|
value: {
|
|
"errcode": "M_FORBIDDEN",
|
|
"error": "Profile lookup over federation is disabled on this homeserver"
|
|
}
|
|
"404":
|
|
description: There is no profile information for this user or this user does not
|
|
exist.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: definitions/errors/error.yaml
|
|
examples:
|
|
response:
|
|
value: {
|
|
"errcode": "M_NOT_FOUND",
|
|
"error": "Profile not found"
|
|
}
|
|
tags:
|
|
- User data
|
|
servers:
|
|
- url: "{protocol}://{hostname}{basePath}"
|
|
variables:
|
|
protocol:
|
|
enum:
|
|
- http
|
|
- https
|
|
default: https
|
|
hostname:
|
|
default: localhost:8008
|
|
basePath:
|
|
default: /_matrix/client/v3
|
|
components:
|
|
securitySchemes:
|
|
$ref: definitions/security.yaml
|