Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MSC3069: Allow guests to use /account/whoami #3069

Merged
merged 2 commits into from
Oct 24, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions proposals/3069-guests-whoami.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# MSC3069: Allow guests to use /account/whoami

Currently the [/account/whoami](https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-account-whoami)
endpoint does not mention anything about guests, which is a bit of an oversight. The implementation
of the endpoint got created such that guest access was declined.

## Proposal

Guests are allowed to use `/account/whoami`. When a guest makes a request, the response will have
an added `is_guest: true` field - this field is optional (default `false`) otherwise.

## Potential issues

None forseen. This corrects a mistake.

## Alternatives

None relevant.

## Security considerations

Guests will be able to know their user ID, as they would when they registered in the first place.

## Unstable prefix

While this MSC is not in a stable version of the specification, implementations should use
`org.matrix.msc3069.is_guest` in place of `is_guest`. Callers should note that they might see
`M_GUEST_ACCESS_FORBIDDEN` errors if the server is not implementing this MSC.