Permanently disable specified users (admin only).
Conduit user.disable
user.disable
user.disable
API Method: user.disable
API Method: user.disable
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Stability
- Deprecated Method: Obsoleted by method "user.edit".
- Returns
- void
- Errors
- ERR-PERMISSIONS: Only admins can call this method.
- ERR-BAD-PHID: Non existent user PHID.
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://admin.phacility.com/ --conduit-token <conduit-token> -- user.disable
$ curl https://admin.phacility.com/api/user.disable \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://admin.phacility.com/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('user.disable', $api_parameters);
print_r($result);