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

Latest commit

 

History

History
331 lines (242 loc) · 13.2 KB

RealmsApi.md

File metadata and controls

331 lines (242 loc) · 13.2 KB
Raw

OpenEuropa\SyncopePhpClient\RealmsApi

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

Method HTTP request Description
createRootedRealm POST /realms/{parentPath} Creates a new realm under the given path.
deleteRealm DELETE /realms/{fullPath} Deletes the realm under the given path.
listRealm GET /realms/{fullPath} Returns realms rooted at the given path.
listRealm_0 GET /realms Returns a list of all realms.
updateRealm PUT /realms/{fullPath} Updates the realm under the given path.

createRootedRealm

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult createRootedRealm($parentPath, $xSyncopeDomain, $realmTO, $prefer, $xSyncopeNullPriorityAsync)

Creates a new realm under the given path.

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\RealmsApi(
    // 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
);
$parentPath = 'parentPath_example'; // string | 
$xSyncopeDomain = 'Master'; // string | 
$realmTO = new \OpenEuropa\SyncopePhpClient\Model\RealmTO(); // \OpenEuropa\SyncopePhpClient\Model\RealmTO | 
$prefer = 'return-content'; // string | Allows client to specify a preference for the result to be returned from the server
$xSyncopeNullPriorityAsync = false; // bool | If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set

try {
    $result = $apiInstance->createRootedRealm($parentPath, $xSyncopeDomain, $realmTO, $prefer, $xSyncopeNullPriorityAsync);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RealmsApi->createRootedRealm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
parentPath string
xSyncopeDomain string [default to 'Master']
realmTO \OpenEuropa\SyncopePhpClient\Model\RealmTO
prefer string Allows client to specify a preference for the result to be returned from the server [optional] [default to 'return-content']
xSyncopeNullPriorityAsync bool If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set [optional] [default to false]

Return type

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult

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]

deleteRealm

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult deleteRealm($fullPath, $xSyncopeDomain, $prefer, $xSyncopeNullPriorityAsync)

Deletes the realm under the given path.

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\RealmsApi(
    // 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
);
$fullPath = 'fullPath_example'; // string | 
$xSyncopeDomain = 'Master'; // string | 
$prefer = 'return-content'; // string | Allows client to specify a preference for the result to be returned from the server
$xSyncopeNullPriorityAsync = false; // bool | If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set

try {
    $result = $apiInstance->deleteRealm($fullPath, $xSyncopeDomain, $prefer, $xSyncopeNullPriorityAsync);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RealmsApi->deleteRealm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fullPath string
xSyncopeDomain string [default to 'Master']
prefer string Allows client to specify a preference for the result to be returned from the server [optional] [default to 'return-content']
xSyncopeNullPriorityAsync bool If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set [optional] [default to false]

Return type

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult

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]

listRealm

\OpenEuropa\SyncopePhpClient\Model\GroupTO listRealm($fullPath, $xSyncopeDomain)

Returns realms rooted at the given path.

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\RealmsApi(
    // 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
);
$fullPath = 'fullPath_example'; // string | full path of the root realm where to read from
$xSyncopeDomain = 'Master'; // string | 

try {
    $result = $apiInstance->listRealm($fullPath, $xSyncopeDomain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RealmsApi->listRealm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fullPath string full path of the root realm where to read from
xSyncopeDomain string [default to 'Master']

Return type

\OpenEuropa\SyncopePhpClient\Model\GroupTO

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]

listRealm_0

listRealm_0($xSyncopeDomain)

Returns a list of all realms.

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\RealmsApi(
    // 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->listRealm_0($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling RealmsApi->listRealm_0: ', $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]

updateRealm

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult updateRealm($fullPath, $xSyncopeDomain, $realmTO, $prefer, $xSyncopeNullPriorityAsync)

Updates the realm under the given path.

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\RealmsApi(
    // 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
);
$fullPath = 'fullPath_example'; // string | Realm's key
$xSyncopeDomain = 'Master'; // string | 
$realmTO = new \OpenEuropa\SyncopePhpClient\Model\RealmTO(); // \OpenEuropa\SyncopePhpClient\Model\RealmTO | 
$prefer = 'return-content'; // string | Allows client to specify a preference for the result to be returned from the server
$xSyncopeNullPriorityAsync = false; // bool | If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set

try {
    $result = $apiInstance->updateRealm($fullPath, $xSyncopeDomain, $realmTO, $prefer, $xSyncopeNullPriorityAsync);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RealmsApi->updateRealm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
fullPath string Realm's key
xSyncopeDomain string [default to 'Master']
realmTO \OpenEuropa\SyncopePhpClient\Model\RealmTO
prefer string Allows client to specify a preference for the result to be returned from the server [optional] [default to 'return-content']
xSyncopeNullPriorityAsync bool If 'true', instructs the propagation process not to wait for completion when communicating with External Resources with no priority set [optional] [default to false]

Return type

\OpenEuropa\SyncopePhpClient\Model\ProvisioningResult

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]