mirror of
https://akkoma.dev/AkkomaGang/akkoma.git
synced 2024-11-15 03:46:37 +00:00
dfae0050af
I understand that this change is quite unreadable and hard to review, sorry for forgetting to do atomic commits. This patch does not change too much content wise, it just * Gets everything from gitlab wiki * Removes some specific gitlab hacks * Formats all documentation file names to be in snake case so they look the same way as our code does
3.4 KiB
3.4 KiB
Admin API
Admin API
Authentication is required and the user must be an admin.
/api/pleroma/admin/users
List users
- Method
GET
- Query Params:
- optional
query
: string search term - optional
filters
: string comma-separated string of filters:local
: only local usersexternal
: only external usersactive
: only active usersdeactivated
: only deactivated users
- optional
page
: integer page number - optional
page_size
: integer number of users per page (default is50
)
- optional
- Example:
https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10
- Response:
{
"page_size": integer,
"count": integer,
"users": [
{
"deactivated": bool,
"id": integer,
"nickname": string,
"roles": {
"admin": bool,
"moderator": bool
},
"local": bool,
"tags": array
},
...
]
}
/api/pleroma/admin/user
Remove a user
- Method
DELETE
- Params:
nickname
- Response: User’s nickname
Create a user
- Method:
POST
- Params:
nickname
email
password
- Response: User’s nickname
/api/pleroma/admin/users/:nickname/toggle_activation
Toggle user activation
- Method:
PATCH
- Params:
nickname
- Response: User’s object
{
"deactivated": bool,
"id": integer,
"nickname": string
}
/api/pleroma/admin/users/tag
Tag a list of users
- Method:
PUT
- Params:
nickname
tags
Untag a list of users
- Method:
DELETE
- Params:
nickname
tags
/api/pleroma/admin/permission_group/:nickname
Get user user permission groups membership
- Method:
GET
- Params: none
- Response:
{
"is_moderator": bool,
"is_admin": bool
}
/api/pleroma/admin/permission_group/:nickname/:permission_group
Note: Available :permission_group
is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
Get user user permission groups membership per permission group
- Method:
GET
- Params: none
- Response:
{
"is_moderator": bool,
"is_admin": bool
}
Add user in permission group
- Method:
POST
- Params: none
- Response:
- On failure:
{"error": "…"}
- On success: JSON of the
user.info
- On failure:
Remove user from permission group
- Method:
DELETE
- Params: none
- Response:
- On failure:
{"error": "…"}
- On success: JSON of the
user.info
- On failure:
- Note: An admin cannot revoke their own admin status.
/api/pleroma/admin/activation_status/:nickname
Active or deactivate a user
- Method:
PUT
- Params:
nickname
status
BOOLEAN field, false value means deactivation.
/api/pleroma/admin/relay
Follow a Relay
- Methods:
POST
- Params:
relay_url
- Response:
- On success: URL of the followed relay
Unfollow a Relay
- Methods:
DELETE
- Params:
relay_url
- Response:
- On success: URL of the unfollowed relay
/api/pleroma/admin/invite_token
Get a account registeration invite token
- Methods:
GET
- Params: none
- Response: invite token (base64 string)
/api/pleroma/admin/email_invite
Sends registration invite via email
- Methods:
POST
- Params:
email
name
, optionnal
/api/pleroma/admin/password_reset
Get a password reset token for a given nickname
- Methods:
GET
- Params: none
- Response: password reset token (base64 string)