diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/admin_api.md | 31 | ||||
| -rw-r--r-- | docs/api/differences_in_mastoapi_responses.md | 10 | ||||
| -rw-r--r-- | docs/api/pleroma_api.md | 9 | ||||
| -rw-r--r-- | docs/config.md | 6 | 
4 files changed, 43 insertions, 13 deletions
| diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index 8befa8ea0..75fa2ee83 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -8,15 +8,20 @@ Authentication is required and the user must be an admin.  - Method `GET`  - Query Params: -  - *optional* `query`: **string** search term +  - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)    - *optional* `filters`: **string** comma-separated string of filters:      - `local`: only local users      - `external`: only external users      - `active`: only active users      - `deactivated`: only deactivated users +    - `is_admin`: users with admin role +    - `is_moderator`: users with moderator role    - *optional* `page`: **integer** page number    - *optional* `page_size`: **integer** number of users per page (default is `50`) -- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10` +  - *optional* `tags`: **[string]** tags list +  - *optional* `name`: **string** user display name +  - *optional* `email`: **string** user email +- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10&tags[]=some_tag&tags[]=another_tag&name=display_name&email=email@example.com`  - Response:  ```JSON @@ -40,7 +45,7 @@ Authentication is required and the user must be an admin.  }  ``` -## `/api/pleroma/admin/user` +## `/api/pleroma/admin/users`  ### Remove a user @@ -58,7 +63,7 @@ Authentication is required and the user must be an admin.    - `password`  - Response: User’s nickname -## `/api/pleroma/admin/user/follow` +## `/api/pleroma/admin/users/follow`  ### Make a user follow another user  - Methods: `POST` @@ -68,7 +73,7 @@ Authentication is required and the user must be an admin.  - Response:   - "ok" -## `/api/pleroma/admin/user/unfollow` +## `/api/pleroma/admin/users/unfollow`  ### Make a user unfollow another user  - Methods: `POST` @@ -111,7 +116,7 @@ Authentication is required and the user must be an admin.    - `nickname`    - `tags` -## `/api/pleroma/admin/permission_group/:nickname` +## `/api/pleroma/admin/users/:nickname/permission_group`  ### Get user user permission groups membership @@ -126,7 +131,7 @@ Authentication is required and the user must be an admin.  }  ``` -## `/api/pleroma/admin/permission_group/:nickname/:permission_group` +## `/api/pleroma/admin/users/:nickname/permission_group/:permission_group`  Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist. @@ -160,7 +165,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret    - On success: JSON of the `user.info`  - Note: An admin cannot revoke their own admin status. -## `/api/pleroma/admin/activation_status/:nickname` +## `/api/pleroma/admin/users/:nickname/activation_status`  ### Active or deactivate a user @@ -198,7 +203,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret  - Response:    - On success: URL of the unfollowed relay -## `/api/pleroma/admin/invite_token` +## `/api/pleroma/admin/users/invite_token`  ### Get an account registration invite token @@ -210,7 +215,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret    ]  - Response: invite token (base64 string) -## `/api/pleroma/admin/invites` +## `/api/pleroma/admin/users/invites`  ### Get a list of generated invites @@ -236,7 +241,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret  }  ``` -## `/api/pleroma/admin/revoke_invite` +## `/api/pleroma/admin/users/revoke_invite`  ### Revoke invite by token @@ -259,7 +264,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret  ``` -## `/api/pleroma/admin/email_invite` +## `/api/pleroma/admin/users/email_invite`  ### Sends registration invite via email @@ -268,7 +273,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret    - `email`    - `name`, optional -## `/api/pleroma/admin/password_reset` +## `/api/pleroma/admin/users/:nickname/password_reset`  ### Get a password reset token for a given nickname diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md index d3ba41b6a..36b47608e 100644 --- a/docs/api/differences_in_mastoapi_responses.md +++ b/docs/api/differences_in_mastoapi_responses.md @@ -87,3 +87,13 @@ Additional parameters can be added to the JSON body/Form data:  `POST /oauth/token`  Post here request with grant_type=refresh_token to obtain new access token. Returns an access token. + +## Account Registration +`POST /api/v1/accounts` + +Has theses additionnal parameters (which are the same as in Pleroma-API): +    * `fullname`: optional +    * `bio`: optional +    * `captcha_solution`: optional, contains provider-specific captcha solution, +    * `captcha_token`: optional, contains provider-specific captcha token +    * `token`: invite token required when the registerations aren't public. diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md index 190846de9..dd0b6ca73 100644 --- a/docs/api/pleroma_api.md +++ b/docs/api/pleroma_api.md @@ -61,6 +61,15 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi  * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise  * Example response: `{"error": "Invalid password."}` +## `/api/pleroma/disable_account` +### Disable an account +* Method `POST` +* Authentication: required +* Params: +    * `password`: user's password +* Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise +* Example response: `{"error": "Invalid password."}` +  ## `/api/account/register`  ### Register a new user  * Method `POST` diff --git a/docs/config.md b/docs/config.md index 43ea24d80..470f71b7c 100644 --- a/docs/config.md +++ b/docs/config.md @@ -105,6 +105,12 @@ config :pleroma, Pleroma.Emails.Mailer,  * `safe_dm_mentions`: If set to true, only mentions at the beginning of a post will be used to address people in direct messages. This is to prevent accidental mentioning of people when talking about them (e.g. "@friend hey i really don't like @enemy"). (Default: `false`)  * `healthcheck`: if set to true, system data will be shown on ``/api/pleroma/healthcheck``. +## :app_account_creation +REST API for creating an account settings +* `enabled`: Enable/disable registration +* `max_requests`: Number of requests allowed for creating accounts +* `interval`: Interval for restricting requests for one ip (seconds) +  ## :logger  * `backends`: `:console` is used to send logs to stdout, `{ExSyslogger, :ex_syslogger}` to log to syslog, and `Quack.Logger` to log to Slack | 
