diff options
| author | Maxim Filippov <colixer@gmail.com> | 2019-09-22 16:58:39 +0300 |
|---|---|---|
| committer | Maxim Filippov <colixer@gmail.com> | 2019-09-22 16:58:39 +0300 |
| commit | 02bbcd6180702828b08a37ccf214cc3b7d5ebd24 (patch) | |
| tree | 73ce407b898050eeb08352ca1e8368918d1ba2bc /docs/api/admin_api.md | |
| parent | f89fe3ac06505cc07372fcdefdc3fde72d1f04a0 (diff) | |
| parent | 472e7b796cfeb1445ee1572df414531655b050ce (diff) | |
| download | pleroma-02bbcd6180702828b08a37ccf214cc3b7d5ebd24.tar.gz pleroma-02bbcd6180702828b08a37ccf214cc3b7d5ebd24.zip | |
Merge branch 'develop' into feature/return-link-for-password-reset
Diffstat (limited to 'docs/api/admin_api.md')
| -rw-r--r-- | docs/api/admin_api.md | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index 8bc6379aa..bc45871a3 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -224,15 +224,25 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ## `/api/pleroma/admin/users/invite_token` -### Get an account registration invite token +### Create an account registration invite token -- Methods: `GET` +- Methods: `POST` - Params: - - *optional* `invite` => [ - - *optional* `max_use` (integer) - - *optional* `expires_at` (date string e.g. "2019-04-07") - ] -- Response: invite token (base64 string) + - *optional* `max_use` (integer) + - *optional* `expires_at` (date string e.g. "2019-04-07") +- 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/users/invites` |