1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Moritz 5ebc8ad418
Replace and fix broken links with hugos relref (#801)
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
2020-08-10 23:01:50 +02:00

1.3 KiB

title description menu
Token Represents an OAuth token used for authenticating with the API and performing actions.
docs
parent
entities

Example

{
  "access_token": "ZA-Yj3aBD8U8Cm7lKUp-lm9O9BmDgdhHzDeqsY8tlL0",
  "token_type": "Bearer",
  "scope": "read write follow push",
  "created_at": 1573979017
}

Attributes

access_token

Description: An OAuth token to be used for authorization.
Type: String
Version history: Added in 0.1.0

token_type

Description: The OAuth token type. Mastodon uses Bearer tokens.
Type: String
Version history: Added in 0.1.0

scope

Description: The OAuth scopes granted by this token, space-separated.
Type: String
Version history: Added in 0.1.0

created_at

Description: When the token was generated.
Type: Number (UNIX Timestamp)
Version history: Added in 0.1.0

See also

  • [Example authorization code flow]({{< relref "../client/token.md#example-authorization-code-flow" >}})
  • [OAuth Scopes]({{< relref "../api/oauth-scopes.md" >}})
  • [POST /oauth/token]({{< relref "../methods/apps/oauth.md#obtain-a-token" >}})

{{< page-ref page="methods/apps/oauth.md" >}}