akkoma/docs/api/admin_api.md
lambda 749d53e2b2 Merge branch 'sayonara-gitlab-wiki' into 'develop'
Move out of Gitlab Wiki

See merge request pleroma/pleroma!990
2019-03-29 10:24:52 +00:00

3.6 KiB
Raw Blame History

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 users
      • external: only external users
      • active: only active users
      • deactivated: only deactivated users
    • 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
  • 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: Users nickname

Create a user

  • Method: POST
  • Params:
    • nickname
    • email
    • password
  • Response: Users nickname

/api/pleroma/admin/users/:nickname/toggle_activation

Toggle user activation

  • Method: PATCH
  • Params:
    • nickname
  • Response: Users 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 doesnt 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

Remove user from permission group

  • Method: DELETE
  • Params: none
  • Response:
    • On failure: {"error": "…"}
    • On success: JSON of the user.info
  • 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/users/:nickname

Retrive the details of a user

  • Method: GET
  • Params:
    • nickname
  • Response:
    • On failure: Not found
    • On success: JSON of the user

/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)