Sidebar

manual:api:reference:user:unblock

user.unblock

Description

object user.unblock(array userids)

This method allows to unblock users.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of users to unblock.

Return values

(object) Returns an object containing the IDs of the unblocked users under the userids property.

Examples

Unblocking multiple users

Unblock two users.

Request:

{
    "jsonrpc": "2.0",
    "method": "user.unblock",
    "params": [
        "1",
        "5"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "1",
            "5"
        ]
    },
    "id": 1
}

Source

CUser::unblock() in ui/include/classes/api/services/CUser.php.