Session management

Gets information about the owner of an access token.

Gets information about the owner of a given access token.

Note that, as with the rest of the Client-Server API, Application Services may masquerade as users within their namespace by giving a user_id query parameter. In this situation, the server should verify that the given user_id is registered by the appservice, and return it in the response body.

get/_matrix/client/v3/account/whoami

Request

Response

The token belongs to a known user.

device_idstring

Device ID associated with the access token. If no device is associated with the access token (such as in the case of application services) then this field can be omitted. Otherwise this is required.

is_guestboolean

When true, the user is a Guest User. When not present or false, the user is presumed to be a non-guest user.

user_idstring mx-user-id required

The user ID that owns the access token.

Changes

No recorded changes to this operation across all 1 revision of this API.