Skip to content

Commit

Permalink
Merge pull request #1063 from turt2live/travis/whoami
Browse files Browse the repository at this point in the history
Spec /account/whoami
  • Loading branch information
richvdh authored Nov 14, 2017
2 parents 88fb2e9 + 2468c38 commit 85340a9
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 0 deletions.
52 changes: 52 additions & 0 deletions api/client-server/whoami.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Copyright 2017 Travis Ralston
#
# 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.
swagger: '2.0'
info:
title: "Matrix Client-Server Account Identification API"
version: "1.0.0"
host: localhost:8008
schemes:
- https
- http
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
produces:
- application/json
securityDefinitions:
$ref: definitions/security.yaml
paths:
"/account/whoami":
get:
summary: Gets information about the owner of an access token.
description: |-
Gets information about the owner of a given access token.
security:
- accessToken: []
parameters: []
responses:
200:
description:
The token belongs to a known user.
examples:
application/json: {
"user_id": "@joe:example.org"
}
schema:
type: object
required: ["user_id"]
properties:
user_id:
type: string
description: The user id that owns the access token.
tags:
- User data
3 changes: 3 additions & 0 deletions changelogs/client_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@
- ``GET /rooms/{roomId}/joined_members``
(`#999 <https://github.com/matrix-org/matrix-doc/pull/999>`_).

- ``GET /account/whoami``
(`#1063 <https://github.com/matrix-org/matrix-doc/pull/1063>`_).

- Spec clarifications:

- Add endpoints and logic for invites and third-party invites to the federation
Expand Down
5 changes: 5 additions & 0 deletions specification/client_server_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -786,6 +786,11 @@ This is independent of any information kept by any Identity Servers.

{{administrative_contact_cs_http_api}}

Current account information
~~~~~~~~~~~~~~~~~~~~~~~~~~~

{{whoami_cs_http_api}}

Pagination
----------

Expand Down

0 comments on commit 85340a9

Please sign in to comment.