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

Latest commit

 

History

History
325 lines (236 loc) · 11.3 KB

ImplementationsApi.md

File metadata and controls

325 lines (236 loc) · 11.3 KB
Raw

OpenEuropa\SyncopePhpClient\ImplementationsApi

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

Method HTTP request Description
create POST /implementations/{type}/{key} Creates a new implementation.
delete1 DELETE /implementations/{type}/{key} Deletes the implementation matching the given key and type.
list10 GET /implementations/{type} Returns a list of all implementations of the given type.
read13 GET /implementations/{type}/{key} Returns implementation with matching type and key.
update PUT /implementations/{type}/{key} Updates an existing implementation.

create

create($type, $key, $xSyncopeDomain, $implementationTO)

Creates a new implementation.

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\ImplementationsApi(
    // 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
);
$type = 'type_example'; // string | Implementation's type
$key = 'key_example'; // string | Implementation's key
$xSyncopeDomain = 'Master'; // string | 
$implementationTO = new \OpenEuropa\SyncopePhpClient\Model\ImplementationTO(); // \OpenEuropa\SyncopePhpClient\Model\ImplementationTO | 

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

Parameters

Name Type Description Notes
type string Implementation's type
key string Implementation's key
xSyncopeDomain string [default to 'Master']
implementationTO \OpenEuropa\SyncopePhpClient\Model\ImplementationTO

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($type, $key, $xSyncopeDomain)

Deletes the implementation matching the given key and type.

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\ImplementationsApi(
    // 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
);
$type = 'type_example'; // string | implementation type
$key = 'key_example'; // string | key for implementation to be deleted
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
type string implementation type
key string key for implementation 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]

list10

list10($type, $xSyncopeDomain)

Returns a list of all implementations of the given type.

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\ImplementationsApi(
    // 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
);
$type = 'type_example'; // string | implementation type
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

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

read13

read13($type, $key, $xSyncopeDomain)

Returns implementation with matching type and 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\ImplementationsApi(
    // 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
);
$type = 'type_example'; // string | implementation type
$key = 'key_example'; // string | key of implementation to be read
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name Type Description Notes
type string implementation type
key string key of implementation to be read
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($type, $key, $xSyncopeDomain, $implementationTO)

Updates an existing implementation.

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\ImplementationsApi(
    // 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
);
$type = 'type_example'; // string | Implementation's type
$key = 'key_example'; // string | Implementation's key
$xSyncopeDomain = 'Master'; // string | 
$implementationTO = new \OpenEuropa\SyncopePhpClient\Model\ImplementationTO(); // \OpenEuropa\SyncopePhpClient\Model\ImplementationTO | 

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

Parameters

Name Type Description Notes
type string Implementation's type
key string Implementation's key
xSyncopeDomain string [default to 'Master']
implementationTO \OpenEuropa\SyncopePhpClient\Model\ImplementationTO

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]