Terminate all web login sessions. If called via OAuth, also terminate the current OAuth token.
WARNING: This method does what it claims on the label. If you call this method via the test console in the web UI, it will log you out!
Conduit auth.logout
auth.logout
auth.logout
API Method: auth.logout
API Method: auth.logout
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Stability
- Unstable Method: These methods are recently introduced and subject to change.
- Returns
- void
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may always call this 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://stash.despawningbone.me/ --conduit-token <conduit-token> auth.logout
$ curl https://stash.despawningbone.me/api/auth.logout \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/libphutil/src/__phutil_library_init__.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://stash.despawningbone.me/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('auth.logout', $api_parameters);
print_r($result);