smitten/akkoma
1
0
Fork 0
forked from AkkomaGang/akkoma
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add docs

Browse source
This commit is contained in:
Maxim Filippov 2019-03-02 17:32:46 +03:00
parent bf30df99cb
commit 08c6aeeed7
1 changed files with 31 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
docs/Admin-API.md
View file

@ -7,20 +7,27 @@ Authentication is required and the user must be an admin.
### List users
- Method `GET`
- Params:
- `page`: **integer** page number
- `page_size`: **integer** number of users per page (default is `50`)
- Response:
```JSON
[
{
"page_size": integer,
"count": integer,
"users": [
{
"deactivated": bool,
"id": integer,
"nickname": string
"deactivated": bool,
"id": integer,
"nickname": string
},
...
]
]
}
```
## `/api/pleroma/admin/users/search?query={query}&local={local}`
## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}`
### Search users by name or nickname
@ -28,17 +35,23 @@ Authentication is required and the user must be an admin.
- Params:
- `query`: **string** search term
- `local`: **bool** whether to return only local users
- `page`: **integer** page number
- `page_size`: **integer** number of users per page (default is `50`)
- Response:
```JSON
[
{
"page_size": integer,
"count": integer,
"users": [
{
"deactivated": bool,
"id": integer,
"nickname": string
"deactivated": bool,
"id": integer,
"nickname": string
},
...
]
]
}
```
## `/api/pleroma/admin/user`
@ -70,9 +83,9 @@ Authentication is required and the user must be an admin.
```JSON
{
"deactivated": bool,
"id": integer,
"nickname": string
"deactivated": bool,
"id": integer,
"nickname": string
}
```
@ -102,8 +115,8 @@ Authentication is required and the user must be an admin.
```JSON
{
"is_moderator": bool,
"is_admin": bool
"is_moderator": bool,
"is_admin": bool
}
```
@ -119,8 +132,8 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
```JSON
{
"is_moderator": bool,
"is_admin": bool
"is_moderator": bool,
"is_admin": bool
}
```