diff options
| author | Alex Gleason <alex@alexgleason.me> | 2021-03-24 12:50:05 -0500 |
|---|---|---|
| committer | Alex Gleason <alex@alexgleason.me> | 2021-03-24 12:50:05 -0500 |
| commit | b6a69b5efda5f75ad716252c69ae658a4e885b0a (patch) | |
| tree | 7956ee8821d98ec4e3276fdb930f359a89a06951 /docs/development | |
| parent | caadde3b04cf4c6509cc0841a338503e646221a0 (diff) | |
| download | pleroma-b6a69b5efda5f75ad716252c69ae658a4e885b0a.tar.gz | |
Return token's primary key with POST /oauth/token
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index a14fcb416..3552b12fb 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -255,9 +255,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 |