Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

Latest commit

 

History

History
207 lines (152 loc) · 8.33 KB

ReconciliationApi.md

File metadata and controls

207 lines (152 loc) · 8.33 KB
Raw

OpenEuropa\SyncopePhpClient\ReconciliationApi

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

Method HTTP request Description
pull POST /reconciliation/pull Pulls the given user, group or any object from the External Resource into Syncope.
push POST /reconciliation/push Pushes the given user, group or any object in Syncope onto the External Resource.
status GET /reconciliation Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.

pull

pull($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain, $pullTaskTO)

Pulls the given user, group or any object from the External Resource into Syncope.

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\ReconciliationApi(
    // 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
);
$anyTypeKind = 'anyTypeKind_example'; // string | anyTypeKind
$anyKey = 'anyKey_example'; // string | user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as  a (user)name
$resourceKey = 'resourceKey_example'; // string | resource key
$xSyncopeDomain = 'Master'; // string | pull specification
$pullTaskTO = new \OpenEuropa\SyncopePhpClient\Model\PullTaskTO(); // \OpenEuropa\SyncopePhpClient\Model\PullTaskTO | 

try {
    $apiInstance->pull($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain, $pullTaskTO);
} catch (Exception $e) {
    echo 'Exception when calling ReconciliationApi->pull: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
anyTypeKind string anyTypeKind
anyKey string user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name
resourceKey string resource key
xSyncopeDomain string pull specification [default to 'Master']
pullTaskTO \OpenEuropa\SyncopePhpClient\Model\PullTaskTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

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

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

push

push($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain, $pushTaskTO)

Pushes the given user, group or any object in Syncope onto the External Resource.

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\ReconciliationApi(
    // 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
);
$anyTypeKind = 'anyTypeKind_example'; // string | anyTypeKind
$anyKey = 'anyKey_example'; // string | user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as  a (user)name
$resourceKey = 'resourceKey_example'; // string | resource key
$xSyncopeDomain = 'Master'; // string | push specification
$pushTaskTO = new \OpenEuropa\SyncopePhpClient\Model\PushTaskTO(); // \OpenEuropa\SyncopePhpClient\Model\PushTaskTO | 

try {
    $apiInstance->push($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain, $pushTaskTO);
} catch (Exception $e) {
    echo 'Exception when calling ReconciliationApi->push: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
anyTypeKind string anyTypeKind
anyKey string user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name
resourceKey string resource key
xSyncopeDomain string push specification [default to 'Master']
pushTaskTO \OpenEuropa\SyncopePhpClient\Model\PushTaskTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

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

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

status

status($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain)

Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.

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\ReconciliationApi(
    // 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
);
$anyTypeKind = 'anyTypeKind_example'; // string | anyTypeKind
$anyKey = 'anyKey_example'; // string | user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as  a (user)name
$resourceKey = 'resourceKey_example'; // string | resource key
$xSyncopeDomain = 'Master'; // string | 

try {
    $apiInstance->status($anyTypeKind, $anyKey, $resourceKey, $xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling ReconciliationApi->status: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
anyTypeKind string anyTypeKind
anyKey string user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name
resourceKey string resource 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]