user_admin_api.rst

Contents

• Query User Account
• Create or modify Account
• List Accounts
• Query current sessions for a user
• Deactivate Account
• Reset password
• Get whether a user is a server administrator or not
• Change whether a user is a server administrator or not
• User devices
  • List all devices
  • Delete multiple devices
  • Show a device
  • Update a device
  • Delete a device

Query User Account

This API returns information about a specific user account.

The api is:

GET /_synapse/admin/v2/users/<user_id>

To use it, you will need to authenticate by providing an access_token for a server admin: see README.rst.

It returns a JSON body like the following:

{
    "displayname": "User",
    "threepids": [
        {
            "medium": "email",
            "address": "<user_mail_1>"
        },
        {
            "medium": "email",
            "address": "<user_mail_2>"
        }
    ],
    "avatar_url": "<avatar_url>",
    "admin": false,
    "deactivated": false
}

URL parameters:

• user_id: fully-qualified user id: for example, @user:server.com.

Create or modify Account

This API allows an administrator to create or modify a user account with a specific user_id.

This api is:

PUT /_synapse/admin/v2/users/<user_id>

with a body of:

{
    "password": "user_password",
    "displayname": "User",
    "threepids": [
        {
            "medium": "email",
            "address": "<user_mail_1>"
        },
        {
            "medium": "email",
            "address": "<user_mail_2>"
        }
    ],
    "avatar_url": "<avatar_url>",
    "admin": false,
    "deactivated": false
}

To use it, you will need to authenticate by providing an access_token for a server admin: see README.rst.

URL parameters: