Query users.
Conduit user.query
user.query
user.query
API Method: user.query
API Method: user.query
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Stability
- Frozen Method: This method is frozen and will eventually be deprecated. New code should use "user.search" instead.
- Summary
- Query users.
- Returns
- list<dict>
- Errors
- ERR-INVALID-PARAMETER: Missing or malformed parameter.
- 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://projects.clusterlabs.org/ --conduit-token <conduit-token> -- user.query
$ curl https://projects.clusterlabs.org/api/user.query \
-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://projects.clusterlabs.org/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('user.query', $api_parameters);
print_r($result);