Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API #2141
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since account locking and suspension are authentication API agnostic, this is a pre-requisite to adding the new OAuth 2.0-based API. This also splits the endpoints that where all included in the registration OpenAPI data, to separate them cleanly in the spec, and avoid having deactivation show before registration. Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
zecakeh
force-pushed
the
split-account-registration
branch
from
cf45f4d to
c68a87c
Compare
Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
zecakeh
changed the title
zecakeh
commented
May 24, 2025
| @@ -0,0 +1 @@ | |||
| Add the OAuth 2.0 based authentication API, as per [MSC3861](https://github.com/matrix-org/matrix-spec-proposals/pull/3861) and its sub-proposals. | |||
There was a problem hiding this comment.
My guess is that we will use this changelog for most of the PRs related to the OAuth 2.0 API.
zecakeh
commented
May 24, 2025
| @@ -764,7 +766,7 @@ auth by offering a stage with only the `m.login.dummy` auth type, but they | |||
| must still give a 401 response to requests with no auth data. | |||
| {{% /boxes/note %}} | |||
|
|
|||
| #### Example | |||
| **Example** | |||
There was a problem hiding this comment.
I downgraded this to a non-heading, because I feel like it doesn't need to appear in the ToC.
zecakeh
commented
May 24, 2025
| @@ -1195,7 +1197,7 @@ with just the session ID: | |||
| } | |||
| ``` | |||
|
|
|||
| ##### Example | |||
| **Example** | |||
There was a problem hiding this comment.
Same here, I downgraded this to a non-heading, because I feel like it doesn't need to appear in the ToC.
This was referenced May 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is supposed to be a PR on which other PRs that add bits of the OAuth 2.0 API will be based. As such it separates the sub-sections that are specific to the legacy API in its own section, and it adds an empty "OAuth 2.0 API" section.
Since account locking and suspension are authentication API agnostic, this also adds a new "Account moderation" section.
This also splits the "Account registration and management" section and its endpoints to separate them cleanly in the spec, for 2 reasons:
The plan for the future is:
Pull Request Checklist
Preview: https://pr2141--matrix-spec-previews.netlify.app