Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Admin api doc edit. Adding cURL command for bearer token without a client. #16334

Draft
bearhudson wants to merge 6 commits intomatrix-org:developfrom
bearhudson:admin_api_doc_fix
Draft

Admin api doc edit. Adding cURL command for bearer token without a client. #16334
bearhudson wants to merge 6 commits intomatrix-org:developfrom
bearhudson:admin_api_doc_fix

Conversation

@bearhudson
Copy link

@bearhudson bearhudson commented Sep 17, 2023 •
edited
Loading

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

@bearhudson bearhudson requested a review from a team as a code owner September 17, 2023 10:36
@bearhudson
Copy link
Author

bearhudson commented Sep 17, 2023

Signed-off-by: Brian Hudson reallybrianhudson@gmail.com

bearhudson
bearhudson commented Sep 17, 2023
View reviewed changes
Copy link
Author

@bearhudson bearhudson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes.

clokep
clokep reviewed Sep 18, 2023
View reviewed changes
docs/usage/administration/admin_api/README.md
Comment on lines +21 to +25
To get an access token from cURL without a client, make a request to `_matrix/client/r0/login` with `type` set to `m.login.password`, `user`, and `password` set to their respective admin account values included in the data field:

```sh
curl -XPOST -d '{"type":"m.login.password", "user":"<admin>", "password":"<password>"}' "http://127.0.0.1:8008/_matrix/client/r0/login"
```
Copy link
Member

@clokep clokep Sep 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This assumes you have password logins enabled. That might be OK, but we should probably clarify that ab it or something?

Copy link
Author

@bearhudson bearhudson Sep 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I will update and resubmit!

@bearhudson bearhudson marked this pull request as draft September 21, 2023 18:54
@matrixbot matrixbot mentioned this pull request Dec 22, 2023
Open
4 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@clokep clokep clokep left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bearhudson @clokep