aboutsummaryrefslogtreecommitdiff
path: root/docs/api/admin_api.md
diff options
context:
space:
mode:
authorkaniini <nenolod@gmail.com>2019-05-11 16:51:23 +0000
committerkaniini <nenolod@gmail.com>2019-05-11 16:51:23 +0000
commit1cb7a15727494da686877d0cae9155973da4148d (patch)
tree6358f7dab3f764cd7cef60864c8546e9f098f04a /docs/api/admin_api.md
parent8d13c42926450aff6a0062f092cd1a5d59f99869 (diff)
parentf01f995816d86999d5cbf261605887b3a3b313ac (diff)
downloadpleroma-1cb7a15727494da686877d0cae9155973da4148d.tar.gz
Merge branch 'uniform-admin-api-url' into 'develop'
make user related url uniform in admin api See merge request pleroma/pleroma!1135
Diffstat (limited to 'docs/api/admin_api.md')
-rw-r--r--docs/api/admin_api.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
index 2657d1243..75fa2ee83 100644
--- a/docs/api/admin_api.md
+++ b/docs/api/admin_api.md
@@ -45,7 +45,7 @@ Authentication is required and the user must be an admin.
}
```
-## `/api/pleroma/admin/user`
+## `/api/pleroma/admin/users`
### Remove a user
@@ -63,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`
@@ -73,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`
@@ -116,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
@@ -131,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.
@@ -165,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
@@ -203,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
@@ -215,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
@@ -241,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
@@ -264,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
@@ -273,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