mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
5ebc8ad418
As discussed in #764 there are quite a lot of outdated links in the mastodon documentation. In basically all cases this was resolved by simply wrapping the old plain markdown link in hugos `relref` function[^0]. While quite a lot of links on the `/zh-cn/` also appear to be broken, these can not be fixed by just wrapping them in `relref`[^0]. Those are all links to `/spec/` subpages which are just not translated to `/zh-cn/` version. Therefore, `/zh-cn/spec/` has been excluded from the automated checking as described in the next section. The page has been checked using the linkchecker[^1] utility. One process is running `hugo serve` in order to see all changes in real time and notice errors directly in your browser. In a separate command prompt the command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just not existing parts of the page as mentioned in the previous paragraph. There still is some ToDo on the table since quite a lot of the anchors appear to not be set or at least differ from previous versions. One example: on `/client/authorized/` is a link to `/client/token/#creating-our-application` while the id of referenced heading is `app`. These changes **do not** fix those Issues as it would require way more time. [^0]: https://gohugo.io/functions/relref/ [^1]: https://github.com/linkchecker/linkchecker Close #764
125 lines
8.0 KiB
Markdown
125 lines
8.0 KiB
Markdown
---
|
|
title: Logging in with an account
|
|
description: How to obtain authorization from a user and perform actions on their behalf.
|
|
menu:
|
|
docs:
|
|
weight: 40
|
|
parent: client
|
|
---
|
|
|
|
## Scopes explained {#scopes}
|
|
|
|
When we registered our app and when we will authorize our user, we need to define what exactly our generated token will have permission to do. This is done through the use of OAuth scopes. Each API method has an associated scope, and can only be called if the token being used for authorization has been generated with the corresponding scope.
|
|
|
|
Scopes must be a subset. When we created our app, we specified `read write follow push` -- we could simply request all available scopes by specifying `read write follow push`, but it is a better idea to only request what your app will actually need through granular scopes. See [OAuth Scopes]({{< relref "../api/oauth-scopes.md" >}}) for a full list of scopes. Each API method's documentation will also specify the OAuth access level and scope required to call it.
|
|
|
|
## **Example authorization code flow** {#flow}
|
|
|
|
This is similar to the authentication flow from before, but this time, we need to obtain authorization from a user as well.
|
|
|
|
### Client ID and secret {#client}
|
|
|
|
First, if you have not already registered a client application, then see [Creating our application]({{< relref "token.md#creating-our-application" >}}) on the previous page or go directly to [POST /api/v1/apps]({{< relref "../methods/apps.md#create-an-application" >}}) for the full documentation of that method. We will need the `client_id` and `client_secret` for our application.
|
|
|
|
### Authorize the user {#login}
|
|
|
|
To authorize a user, request [GET /oauth/authorize]({{< relref "../methods/apps/oauth.md#authorize-a-user" >}}) in a browser with the following query parameters:
|
|
|
|
```bash
|
|
https://mastodon.example/oauth/authorize
|
|
?client_id=CLIENT_ID
|
|
&scope=read+write+follow+push
|
|
&redirect_uri=urn:ietf:wg:oauth:2.0:oob
|
|
&response_type=code
|
|
```
|
|
|
|
Note the following:
|
|
|
|
* `client_id` and `client_secret` were obtained when registering our application.
|
|
* `scope` must be a subset of our registered app's registered scopes. It is a good idea to only request what you need. See [OAuth Scopes]({{< relref "../api/oauth-scopes.md" >}}) for more information.
|
|
* `redirect_uri` is one of the URIs we registered with our app. We are still using "out of band" for this example, which means we will have to manually copy and paste the resulting code, but if you registered your application with a URI that you control, then the code will be returned as a query parameter `code` and can be logged by your request handler. See the response section of the API method documentation for more information on this.
|
|
|
|
### Obtain the token {#token}
|
|
|
|
Now that we have an authorization `code`, let's obtain an access token that will authenticate our requests as the authorized user. To do so, use [POST /oauth/token]({{< relref "../methods/apps/oauth.md#obtain-a-token" >}}) like before, but pass the authorization code we just obtained:
|
|
|
|
```bash
|
|
curl -X POST \
|
|
-F 'client_id=your_client_id_here' \
|
|
-F 'client_secret=your_client_secret_here' \
|
|
-F 'redirect_uri=urn:ietf:wg:oauth:2.0:oob' \
|
|
-F 'grant_type=authorization_code' \
|
|
-F 'code=user_authzcode_here' \
|
|
-F 'scope=read write follow push' \
|
|
https://mastodon.example/oauth/token
|
|
```
|
|
|
|
Note the following:
|
|
|
|
* `client_id` and `client_secret` were provided in the response text when you registered your application.
|
|
* `redirect_uri` must be one of the URIs defined when registering the application.
|
|
* We are requesting a `grant_type` of `authorization_code`, which still defaults to giving us the `read` scope. However, while authorizing our user, we requested a certain `scope` -- pass the exact same value here.
|
|
* The `code` can only be used once. If you need to obtain a new token, you will need to have the user authorize again by repeating the above [Authorize the user]({{< relref "authorized.md#authorize-the-user" >}}) step.
|
|
|
|
The response of this method is a [Token]({{< relref "../entities/token.md" >}}) entity. We will need the `access_token` value. Once you have the access token, save it in your local cache. To use it in requests, add the HTTP header `Authorization: Bearer ...` to any API call that requires OAuth \(i.e., one that is not publicly accessible\). Let's verify that our obtained credentials are working by calling [GET /api/v1/accounts/verify\_credentials]({{< relref "../methods/accounts/#verify-account-credentials" >}}):
|
|
|
|
```bash
|
|
curl \
|
|
-H 'Authorization: Bearer our_access_token_here' \
|
|
https://mastodon.example/api/v1/accounts/verify_credentials
|
|
```
|
|
|
|
If we've obtained our token and formatted our request correctly, we should see our details returned to us as an [Account]({{< relref "../entities/account.md" >}}) entity, with the `source` parameter included.
|
|
|
|
## Performing actions as the authorized user {#actions}
|
|
|
|
With our OAuth token for the authorized user, we can now perform any action as that user that is within our token's scope.
|
|
|
|
### Publish and delete statuses {#statuses}
|
|
|
|
* See [POST /api/v1/statuses]({{< relref "../methods/statuses/#publish-new-status" >}}) for how to create statuses.
|
|
* See [/api/v1/media]({{< relref "../methods/statuses/media.md" >}}) for creating media attachments.
|
|
* See [/api/v1/scheduled\_statuses]({{< relref "../methods/statuses/scheduled_statuses.md" >}}) for managing scheduled statuses.
|
|
|
|
### Interact with timelines {#timelines}
|
|
|
|
* See [/api/v1/timelines]({{< relref "../methods/timelines/" >}}) for accessing timelines.
|
|
* See [/api/v1/markers]({{< relref "../methods/timelines/markers.md" >}}) for saving and loading positions in timelines.
|
|
* See [/api/v1/statuses]({{< relref "../methods/statuses/" >}}) for performing actions on statuses.
|
|
* See [/api/v1/polls]({{< relref "../methods/statuses/polls.md" >}}) for viewing and voting on polls.
|
|
* See [/api/v1/lists]({{< relref "../methods/timelines/lists.md" >}}) for obtaining list IDs to use with [GET /api/v1/timelines/list/:list\_id]({{< relref "../methods/timelines/#list-timeline" >}}).
|
|
* See [/api/v1/conversations]({{< relref "../methods/timelines/conversations.md" >}}) for obtaining direct conversations.
|
|
* See [/api/v1/favourites]({{< relref "../methods/accounts/favourites.md" >}}) for listing favourites.
|
|
* See [/api/v1/bookmarks]({{< relref "../methods/accounts/bookmarks.md" >}}) for listing bookmarks.
|
|
|
|
### Interact with other users {#accounts}
|
|
|
|
* See [/api/v1/accounts]({{< relref "../methods/accounts/" >}}) for performing actions on other users.
|
|
* See [/api/v1/follow\_requests]({{< relref "../methods/accounts/follow_requests.md" >}}) for handling follow requests.
|
|
* See [/api/v1/mutes]({{< relref "../methods/accounts/mutes.md" >}}) for listing mutes.
|
|
* See [/api/v1/blocks]({{< relref "../methods/accounts/blocks.md" >}}) for listing blocks.
|
|
|
|
### Receive notifications {#notifications}
|
|
|
|
* See [/api/v1/notifications]({{< relref "../methods/notifications/" >}}) for managing a user's notifications.
|
|
* See [/api/v1/push]({{< relref "../methods/notifications/push.md" >}}) for subscribing to push notifications.
|
|
|
|
### Discovery features {#discovery}
|
|
|
|
* See [/api/v2/search]({{< relref "../methods/search.md" >}}) for querying resources.
|
|
* See [/api/v1/suggestions]({{< relref "../methods/accounts/suggestions.md" >}}) for suggested accounts to follow.
|
|
|
|
### Use safety features {#safety}
|
|
|
|
* See [/api/v1/filters]({{< relref "../methods/accounts/filters.md" >}}) for managing filtered keywords.
|
|
* See [/api/v1/domain\_blocks]({{< relref "../methods/accounts/domain_blocks.md" >}}) for managing blocked domains.
|
|
* See [/api/v1/reports]({{< relref "../methods/accounts/reports.md" >}}) for creating reports.
|
|
* See [/api/v1/admin]({{< relref "../methods/admin.md" >}}) for moderator actions.
|
|
|
|
### Manage account info {#manage}
|
|
|
|
* See [/api/v1/endorsements]({{< relref "../methods/accounts/endorsements.md" >}}) for managing a user profile's featured accounts.
|
|
* See [/api/v1/featured\_tags]({{< relref "../methods/accounts/featured_tags.md" >}}) for managing a user profile's featured hashtags.
|
|
* See [/api/v1/preferences]({{< relref "../methods/accounts/preferences.md" >}}) for reading user preferences.
|
|
|