OpenEuropa\SyncopePhpClient\ConnectorsApi

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

Method	HTTP request	Description
buildObjectClassInfo	POST /connectors/{key}/supportedObjectClasses	Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.
check	POST /connectors/check	Checks whether the connection to resource could be established.
create	POST /connectors	Creates a new connector instance.
delete1	DELETE /connectors/{key}	Deletes the connector instance matching the provided key.
getBundles	GET /connectors/bundles	Returns available connector bundles with property keys in selected language.
list7	GET /connectors	Returns a list of all connector instances with property keys in the matching language.
read7	GET /connectors/{key}	Returns connector instance with matching key.
readByResource	GET /connectors/byResource/{resourceName}	Returns connector instance for matching resource.
reload	POST /connectors/reload	Reload all connector bundles and instances.
update	PUT /connectors/{key}	Updates the connector instance matching the provided key.

buildObjectClassInfo

buildObjectClassInfo($key, $xSyncopeDomain, $connInstanceTO, $includeSpecial)

Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.

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\ConnectorsApi(
    // 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 instance's key
$xSyncopeDomain = 'Master'; // string | 
$connInstanceTO = new \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO(); // \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO | 
$includeSpecial = false; // bool | if set to true, special schema names (like '__PASSWORD__') will be included;  default is false

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

Parameters

Name	Type	Description	Notes
key	string	Connector instance's key
xSyncopeDomain	string		[default to 'Master']
connInstanceTO	\OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO
includeSpecial	bool	if set to true, special schema names (like 'PASSWORD') will be included; default is false	[optional] [default to false]

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]

check

check($xSyncopeDomain, $connInstanceTO)

Checks whether the connection to resource could be established.

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\ConnectorsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | connector instance to be used for connection check
$connInstanceTO = new \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO(); // \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO | 

try {
    $apiInstance->check($xSyncopeDomain, $connInstanceTO);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorsApi->check: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	connector instance to be used for connection check	[default to 'Master']
connInstanceTO	\OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO

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]

create

create($xSyncopeDomain, $connInstanceTO)

Creates a new connector instance.

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\ConnectorsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | connector instance to be created
$connInstanceTO = new \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO(); // \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO | 

try {
    $apiInstance->create($xSyncopeDomain, $connInstanceTO);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorsApi->create: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	connector instance to be created	[default to 'Master']
connInstanceTO	\OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO

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]

delete1

delete1($key, $xSyncopeDomain)

Deletes the connector 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\ConnectorsApi(
    // 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 instance key to be deleted
$xSyncopeDomain = 'Master'; // string | connector instance to be used for connection check

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

Parameters

Name	Type	Description	Notes
key	string	connector instance key to be deleted
xSyncopeDomain	string	connector instance to be used for connection check	[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]

getBundles

getBundles($xSyncopeDomain, $lang)

Returns available connector bundles with property keys in selected language.

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\ConnectorsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 
$lang = 'lang_example'; // string | language to select property keys; default language is English

try {
    $apiInstance->getBundles($xSyncopeDomain, $lang);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorsApi->getBundles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string		[default to 'Master']
lang	string	language to select property keys; default language is English	[optional]

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]

list7

list7($xSyncopeDomain, $lang)

Returns a list of all connector instances with property keys in the matching language.

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\ConnectorsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 
$lang = 'lang_example'; // string | language to select property keys, null for default (English).  An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

try {
    $apiInstance->list7($xSyncopeDomain, $lang);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorsApi->list7: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string		[default to 'Master']
lang	string	language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.	[optional]

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]

read7

read7($key, $xSyncopeDomain, $lang)

Returns connector instance with matching 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\ConnectorsApi(
    // 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 instance key to be read
$xSyncopeDomain = 'Master'; // string | 
$lang = 'lang_example'; // string | language to select property keys, null for default (English).  An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

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

Parameters

Name	Type	Description	Notes
key	string	connector instance key to be read
xSyncopeDomain	string		[default to 'Master']
lang	string	language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.	[optional]

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]

readByResource

readByResource($resourceName, $xSyncopeDomain, $lang)

Returns connector instance for matching 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\ConnectorsApi(
    // 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
);
$resourceName = 'resourceName_example'; // string | resource name to be used for connector lookup
$xSyncopeDomain = 'Master'; // string | 
$lang = 'lang_example'; // string | language to select property keys, null for default (English).  An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

try {
    $apiInstance->readByResource($resourceName, $xSyncopeDomain, $lang);
} catch (Exception $e) {
    echo 'Exception when calling ConnectorsApi->readByResource: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
resourceName	string	resource name to be used for connector lookup
xSyncopeDomain	string		[default to 'Master']
lang	string	language to select property keys, null for default (English). An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.	[optional]

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]

reload

reload($xSyncopeDomain)

Reload all connector bundles and instances.

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\ConnectorsApi(
    // 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
);
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
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]

update

update($key, $xSyncopeDomain, $connInstanceTO)

Updates the connector 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\ConnectorsApi(
    // 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 instance's key
$xSyncopeDomain = 'Master'; // string | connector instance key to be deleted
$connInstanceTO = new \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO(); // \OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO | 

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

Parameters

Name	Type	Description	Notes
key	string	Connector instance's key
xSyncopeDomain	string	connector instance key to be deleted	[default to 'Master']
connInstanceTO	\OpenEuropa\SyncopePhpClient\Model\ConnInstanceTO

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]

Files

ConnectorsApi.md

Latest commit

History

ConnectorsApi.md

File metadata and controls

OpenEuropa\SyncopePhpClient\ConnectorsApi

buildObjectClassInfo

Example

Parameters

Return type

Authorization

HTTP request headers

check

Example

Parameters

Return type

Authorization

HTTP request headers

create

Example

Parameters

Return type

Authorization

HTTP request headers

delete1

Example

Parameters

Return type

Authorization

HTTP request headers

getBundles

Example

Parameters

Return type

Authorization

HTTP request headers

list7

Example

Parameters

Return type

Authorization

HTTP request headers

read7

Example

Parameters

Return type

Authorization

HTTP request headers

readByResource

Example

Parameters

Return type

Authorization

HTTP request headers

reload

Example

Parameters

Return type

Authorization

HTTP request headers

update

Example

Parameters

Return type

Authorization

HTTP request headers