diff options
| author | Alex Gleason <alex@alexgleason.me> | 2021-07-13 22:47:47 -0500 |
|---|---|---|
| committer | Alex Gleason <alex@alexgleason.me> | 2021-07-13 22:47:47 -0500 |
| commit | deb3f911366925bcc342a4a0deb44a2e7da7f1ba (patch) | |
| tree | c8e587198f64c4c5f991a05561943c6bd0af465b /docs/development | |
| parent | 5e88796784e0ac2dbf57d9cf954fdc8ae8aeae43 (diff) | |
| parent | 173e977e283789a814278c63bc81f40a13942e21 (diff) | |
| download | pleroma-deb3f911366925bcc342a4a0deb44a2e7da7f1ba.tar.gz pleroma-deb3f911366925bcc342a4a0deb44a2e7da7f1ba.zip | |
Merge remote-tracking branch 'pleroma/develop' into admin-api-users-sort
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 25 | ||||
| -rw-r--r-- | docs/development/API/pleroma_api.md | 2 |
2 files changed, 24 insertions, 3 deletions
diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index a14fcb416..6c1ecb559 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -38,6 +38,7 @@ Has these additional fields under the `pleroma` object: - `thread_muted`: true if the thread the post belongs to is muted - `emoji_reactions`: A list with emoji / reaction maps. The format is `{name: "☕", count: 1, me: true}`. Contains no information about the reacting users, for that use the `/statuses/:id/reactions` endpoint. - `parent_visible`: If the parent of this post is visible to the user or not. +- `pinned_at`: a datetime (iso8601) when status was pinned, `null` otherwise. ## Scheduled statuses @@ -255,9 +256,29 @@ This information is returned in the `/api/v1/accounts/verify_credentials` endpoi *Pleroma supports refreshing tokens.* -`POST /oauth/token` +### POST `/oauth/token` -Post here request with `grant_type=refresh_token` to obtain new access token. Returns an access token. +You can obtain access tokens for a user in a few additional ways. + +#### Refreshing a token + +To obtain a new access token from a refresh token, pass `grant_type=refresh_token` with the following extra parameters: + +- `refresh_token`: The refresh token. + +#### Getting a token with a password + +To obtain a token from a user's password, pass `grant_type=password` with the following extra parameters: + +- `username`: Username to authenticate. +- `password`: The user's password. + +#### Response body + +Additional fields are returned in the response: + +- `id`: The primary key of this token in Pleroma's database. +- `me` (user tokens only): The ActivityPub ID of the user who owns the token. ## Account Registration diff --git a/docs/development/API/pleroma_api.md b/docs/development/API/pleroma_api.md index d896f0ce7..8f6422da0 100644 --- a/docs/development/API/pleroma_api.md +++ b/docs/development/API/pleroma_api.md @@ -300,7 +300,7 @@ See [Admin-API](admin_api.md) * Note: Behaves exactly the same as `POST /api/v1/upload`. Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`. -## `/api/v1/pleroma/notification_settings` +## `/api/pleroma/notification_settings` ### Updates user notification settings * Method `PUT` * Authentication: required |