diff options
| author | feld <feld@feld.me> | 2019-09-18 21:11:37 +0000 |
|---|---|---|
| committer | feld <feld@feld.me> | 2019-09-18 21:11:37 +0000 |
| commit | 25b43656565b0044d79d7e969d98a0f8283279fc (patch) | |
| tree | 955e1ca6e8bdcf668f62608fd081c89f9a9239d0 /docs/api/admin_api.md | |
| parent | 220afadc55bfeef28355919ea914d599837f9321 (diff) | |
| parent | a18f1e7cd7addf8aee9c56643f4f0531e1c5b5a0 (diff) | |
| download | pleroma-25b43656565b0044d79d7e969d98a0f8283279fc.tar.gz | |
Merge branch 'admin_api_invite_tokens' into 'develop'
POST for creating invite tokens in admin api
See merge request pleroma/pleroma!1637
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 9362e3d78..7637fa0d4 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` |