matrixbot
commented
2 weeks ago This comment was originally posted by @sandhose at https://github.com/matrix-org/matrix-authentication-service/issues/2605#issuecomment-2109674875.
Now that the documentation covers better how the authorisation process works, we could have two "How to" guides:
- How to get a Synapse admin token
- Cover the easy way: issue a compatibility token via the CLI
- Cover the interactive way:
- Make a user admin (during registration in the CLI, or by editing the
can_request_adminflag on the user in the database) - Do an OAuth 2.0 Device code grant and request the
urn:synapse:admin:*scope
- Make a user admin (during registration in the CLI, or by editing the
- How to interact with the MAS GraphQL API
- Cover the fully automated way:
- Define a static client
- Make that client "admin" in the policy
- Use the client_credentials grant to request the
urn:mas:graphl:*andurn:mas:adminscopes
- Cover the interactive way: Do an OAuth 2.0 Device Code Grant or an Authorisation Code Grant
- Demo a few operations
- Cover the fully automated way:
Covering the device code grant and/or the authorisation code grant is probably a bit complicated, mainly because of the dynamic client registration… Maybe those should have their own how-to guides? FTR, I have this shell script to do the device code grant: https://gist.github.com/sandhose/d548c5914870c3777ac9d0aa5c0ef9ef
cc @reivilibre
This issue was originally created by @sandhose at https://github.com/matrix-org/matrix-authentication-service/issues/2605.
In addition to reference documentation on the various bits related to the GraphQL API, it would be helpful to have a step-by-step guide on how to leverage with the API. Issues for the individual bits needed first: