Add docs
This commit is contained in:
parent
bf30df99cb
commit
08c6aeeed7
|
@ -7,10 +7,16 @@ 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,
|
||||
|
@ -18,9 +24,10 @@ Authentication is required and the user must be an admin.
|
|||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/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,10 +35,15 @@ 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,
|
||||
|
@ -39,6 +51,7 @@ Authentication is required and the user must be an admin.
|
|||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## `/api/pleroma/admin/user`
|
||||
|
|
Loading…
Reference in New Issue