Suspend User

Description

Use the Suspend User API to suspend the user present on your server by passing the user name to the API. The suspended users will not able to login into their account. 

The API response will contain "done" as "User suspended successfully" on successful suspension of the user

parameters

Sample Code

curl -ku "user:password" "https://hostip:2005/index.php?api=json&act=users&suspend=username&skip=1"
<?php
$user = 'your_user';
$pass = 'your_password';
$ip = 'your_ip';
 
$url = 'https://'.rawurlencode($user).':'.rawurlencode($pass).'@'.$ip.':2005/index.php?api=json&act=users'; 

$post = array('suspend' => 'your_username_to_suspend', 'skip' => '1');


// Set the curl parameters 
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 

if(!empty($post)){
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
}

// Get response from the server. 
$resp = curl_exec($ch);

// The response will hold a string as per the API response method. In this case its PHP JSON
$res = json_decode($resp, true);

// Done ?
if(!empty($res['done'])){
	print_r($res['done']);
// Error
}else{
	print_r($res['error']);
}
<?php
include_once('/usr/local/webuzo/sdk/webuzo_sdk_v2.php');
$user = 'your_user';
$pass = 'your_password';
$host = 'your_ip';
$skip = 1;

$webuzo = new Webuzo_Admin_SDK($user, $pass, $host);

$username = 'your_username_to_suspend';
$res = $webuzo->suspend_user($username, $skip);

// Done/Error
if(!empty($res['error'])){
	print_r($res['error']);
}else{
	print_r($res['done']);
}

?>

Output

Array ( [msg] => User suspended successfully )
Was this page helpful?