Skip to content

Latest commit

 

History

History
191 lines (136 loc) · 6.69 KB

ConnectorHistoryApi.md

File metadata and controls

191 lines (136 loc) · 6.69 KB
Raw

OpenEuropa\SyncopePhpClient\ConnectorHistoryApi

All URIs are relative to http://syncope-vm.apache.org:9080/syncope/rest

Method HTTP request Description
delete1 DELETE /connectorsHistory/{key} Deletes the connector configuration history instance matching the provided key.
list6 GET /connectorsHistory/{connectorKey} Returns a list of all connector configuration history instances for the given connector instance key.
restore POST /connectorsHistory/{key} Restores the connector configuration history instance matching the provided key.

delete1

delete1($key, $xSyncopeDomain)

Deletes the connector configuration history instance matching the provided key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ConnectorHistoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$key = 'key_example'; // string | connector configuration history instance key to be deleted
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->delete1($key, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorHistoryApi->delete1: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
key string connector configuration history instance key to be deleted
xSyncopeDomain string [default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list6

list6($connectorKey, $xSyncopeDomain)

Returns a list of all connector configuration history instances for the given connector instance key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ConnectorHistoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$connectorKey = 'connectorKey_example'; // string | connector instance key
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->list6($connectorKey, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorHistoryApi->list6: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
connectorKey string connector instance key
xSyncopeDomain string [default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore

restore($key, $xSyncopeDomain)

Restores the connector configuration history instance matching the provided key.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuthentication
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure HTTP basic authorization: Bearer
$config = OpenEuropa\SyncopePhpClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenEuropa\SyncopePhpClient\Api\ConnectorHistoryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$key = 'key_example'; // string | connector configuration history instance key to be restored
$xSyncopeDomain = 'Master'; // string | connector configuration history instance key to be deleted

try {
    $apiInstance->restore($key, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorHistoryApi->restore: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
key string connector configuration history instance key to be restored
xSyncopeDomain string connector configuration history instance key to be deleted [default to 'Master']

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]