diff options
| author | lambda <lain@soykaf.club> | 2019-04-10 10:10:08 +0000 |
|---|---|---|
| committer | lambda <lain@soykaf.club> | 2019-04-10 10:10:08 +0000 |
| commit | e5d553aa45ffa218b0695d7976f012bfc1dcbafe (patch) | |
| tree | f0f48276f13879fbf7c0355190e511112e473e2b /docs/api/admin_api.md | |
| parent | 6504b43f96860d1911ed9a17d1c487a6e8ac93ba (diff) | |
| parent | fee50636d07c54328ececfe8805c658e3bb80cc6 (diff) | |
| download | pleroma-e5d553aa45ffa218b0695d7976f012bfc1dcbafe.tar.gz | |
Merge branch 'feature/767-multiple-use-invite-token' into 'develop'
Feature/767 multiple use invite token
See merge request pleroma/pleroma!1032
Diffstat (limited to 'docs/api/admin_api.md')
| -rw-r--r-- | docs/api/admin_api.md | 59 |
1 files changed, 56 insertions, 3 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index 86cacebb1..8befa8ea0 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -200,12 +200,65 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ## `/api/pleroma/admin/invite_token` -### Get a account registeration invite token +### Get an account registration invite token - Methods: `GET` -- Params: none +- Params: + - *optional* `invite` => [ + - *optional* `max_use` (integer) + - *optional* `expires_at` (date string e.g. "2019-04-07") + ] - Response: invite token (base64 string) +## `/api/pleroma/admin/invites` + +### Get a list of generated invites + +- Methods: `GET` +- Params: none +- Response: + +```JSON +{ + + "invites": [ + { + "id": integer, + "token": string, + "used": boolean, + "expires_at": date, + "uses": integer, + "max_use": integer, + "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`) + }, + ... + ] +} +``` + +## `/api/pleroma/admin/revoke_invite` + +### Revoke invite by token + +- Methods: `POST` +- Params: + - `token` +- Response: + +```JSON +{ + "id": integer, + "token": string, + "used": boolean, + "expires_at": date, + "uses": integer, + "max_use": integer, + "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`) + +} +``` + + ## `/api/pleroma/admin/email_invite` ### Sends registration invite via email @@ -213,7 +266,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - Methods: `POST` - Params: - `email` - - `name`, optionnal + - `name`, optional ## `/api/pleroma/admin/password_reset` |