diff options
| author | Alex S <alex.strizhakov@gmail.com> | 2019-09-06 17:14:31 +0300 |
|---|---|---|
| committer | Alex S <alex.strizhakov@gmail.com> | 2019-09-18 10:49:14 +0300 |
| commit | 4faf2b1555f004664005e0efddb9815ebca4c5c7 (patch) | |
| tree | fca2b11578b9acb1775f739bac478a168506bb14 /docs/api | |
| parent | 40c968626dde499969d90f256d5ef6d1b1d5e2b4 (diff) | |
| download | pleroma-4faf2b1555f004664005e0efddb9815ebca4c5c7.tar.gz | |
post for creating invite tokens in admin api
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/admin_api.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index 9362e3d78..a8c75d93f 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -226,13 +226,25 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Get 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) +- 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` |