Connect a session-based client.
Conduit conduit.connect
conduit.connect
conduit.connect
API Method: conduit.connect
API Method: conduit.connect
- Summary
- Connect a session-based client.
- Returns
- dict<string, any>
- Errors
- ERR-BAD-VERSION: Client/server version mismatch. Upgrade your server or downgrade your client.
- NEW-ARC-VERSION: Client/server version mismatch. Upgrade your client.
- ERR-UNKNOWN-CLIENT: Client is unknown.
- ERR-INVALID-USER: The username you are attempting to authenticate with is not valid.
- ERR-INVALID-CERTIFICATE: Your authentication certificate for this server is invalid.
- ERR-INVALID-TOKEN: The challenge token you are authenticating with is outside of the allowed time range. Either your system clock is out of whack or you're executing a replay attack.
- ERR-NO-CERTIFICATE: This server requires authentication.
- 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://phorge.apps.ocp04.ait-msp-infra.net/ --conduit-token <conduit-token> -- conduit.connect
$ curl https://phorge.apps.ocp04.ait-msp-infra.net/api/conduit.connect \
-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://phorge.apps.ocp04.ait-msp-infra.net/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('conduit.connect', $api_parameters);
print_r($result);