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

Latest commit

 

History

History
313 lines (224 loc) · 10.3 KB

AnyTypesApi.md

File metadata and controls

313 lines (224 loc) · 10.3 KB
Raw

OpenEuropa\SyncopePhpClient\AnyTypesApi

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

Method HTTP request Description
createAnyType POST /anyTypes Creates a new anyType.
deleteAnyType DELETE /anyTypes/{key} Deletes the anyType matching the provided key.
listAnyType GET /anyTypes Returns a list of all anyTypes.
readAnyType GET /anyTypes/{key} Returns anyType with matching key.
updateAnyType PUT /anyTypes/{key} Updates the anyType matching the provided key.

createAnyType

createAnyType($xSyncopeDomain, $anyTypeTO)

Creates a new anyType.

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\AnyTypesApi(
    // 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 | anyType to be created
$anyTypeTO = new \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO(); // \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO | 

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

Parameters

Name Type Description Notes
xSyncopeDomain string anyType to be created [default to 'Master']
anyTypeTO \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

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

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

deleteAnyType

deleteAnyType($key, $xSyncopeDomain)

Deletes the anyType 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\AnyTypesApi(
    // 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 | anyType key to be deleted
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

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

listAnyType

listAnyType($xSyncopeDomain)

Returns a list of all anyTypes.

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

readAnyType

readAnyType($key, $xSyncopeDomain)

Returns anyType 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\AnyTypesApi(
    // 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 | anyType key to be read
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

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

updateAnyType

updateAnyType($key, $xSyncopeDomain, $anyTypeTO)

Updates the anyType 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\AnyTypesApi(
    // 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 | AnyType's key
$xSyncopeDomain = 'Master'; // string | anyType key to be deleted
$anyTypeTO = new \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO(); // \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO | 

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

Parameters

Name Type Description Notes
key string AnyType's key
xSyncopeDomain string anyType key to be deleted [default to 'Master']
anyTypeTO \OpenEuropa\SyncopePhpClient\Model\AnyTypeTO

Return type

void (empty response body)

Authorization

BasicAuthentication, Bearer

HTTP request headers

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

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