diff options
author | feld <feld@feld.me> | 2021-04-29 19:13:50 +0000 |
---|---|---|
committer | feld <feld@feld.me> | 2021-04-29 19:13:50 +0000 |
commit | 377f84f3678f9c2541fbd4a200cd93c5ab0dea24 (patch) | |
tree | ed7291819e56e40dd8bb6f71089a1c12a9a4e6f9 /docs/development | |
parent | 2fe3bd8178a602bde979a24e5037bb08d48e41b6 (diff) | |
parent | 6bc8ab225d87698416a2dc82c8a894e4ffe85615 (diff) | |
download | pleroma-377f84f3678f9c2541fbd4a200cd93c5ab0dea24.tar.gz pleroma-377f84f3678f9c2541fbd4a200cd93c5ab0dea24.zip |
Merge branch 'oauth-token-id' into 'develop'
Return token's primary key with POST /oauth/token
See merge request pleroma/pleroma!3380
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 2ff56d3ca..6c1ecb559 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -256,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 |