manual:api:reference:user:unblock

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

manual:api:reference:user:unblock [2021/09/20 07:29] (current)
Andrejs.Griscenko [ZBXNEXT-6718] added new method user.unblock
Line 1: Line 1:
 +===== user.unblock =====
  
 +==== Description ====
 +
 +''​object user.unblock(array **userids**)''​
 +
 +This method allows to unblock users.
 +
 +<​note>​This method is only available to //Super admin// user type. Permissions to call the method can be revoked in user role settings. See [[:​manual/​web_interface/​frontend_sections/​administration/​user_roles|User roles]] for more information.</​note>​
 +
 +==== 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:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​method":​ "​user.unblock",​
 +    "​params":​ [
 +        "​1",​
 +        "​5"​
 +    ],
 +    "​auth":​ "​3a57200802b24cda67c4e4010b50c065",​
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +Response:
 +<code java>
 +{
 +    "​jsonrpc":​ "​2.0",​
 +    "​result":​ {
 +        "​userids":​ [
 +            "​1",​
 +            "​5"​
 +        ]
 +    },
 +    "​id":​ 1
 +}
 +</​code>​
 +
 +==== Source ====
 +
 +CUser::​unblock() in //​ui/​include/​classes/​api/​services/​CUser.php//​.