OpenEuropa\SyncopePhpClient\LoggersApi

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

Method	HTTP request	Description
delete1	DELETE /loggers/{type}/{name}	Deletes the logger with matching name.
events	GET /loggers/events	Returns the list of all managed events in audit.
getLastLogStatements	GET /loggers/memoryAppenders/{memoryAppender}/lastLogStatements	Return the last log statements available in the provided memory appender.
list11	GET /loggers/{type}	Returns a list of loggers with matching type.
memoryAppenders	GET /loggers/memoryAppenders	Returns the list of memory appenders available in the current logging configuration.
read14	GET /loggers/{type}/{name}	Returns logger with matching type and name.
update	PUT /loggers/{type}/{key}	Creates or updates (if existing) the logger with matching name.

delete1

delete1($type, $name, $xSyncopeDomain)

Deletes the logger with matching name.

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\LoggersApi(
    // 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 | LoggerType to be selected
$name = 'name_example'; // string | Logger name to be deleted
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
type	string	LoggerType to be selected
name	string	Logger name 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]

events

events($xSyncopeDomain)

Returns the list of all managed events in audit.

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

getLastLogStatements

getLastLogStatements($memoryAppender, $xSyncopeDomain)

Return the last log statements available in the provided memory appender.

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\LoggersApi(
    // 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
);
$memoryAppender = 'memoryAppender_example'; // string | memory appender name
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
memoryAppender	string	memory appender name
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]

list11

list11($type, $xSyncopeDomain)

Returns a list of loggers with matching 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\LoggersApi(
    // 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 | LoggerType to be selected
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
type	string	LoggerType to be selected
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]

memoryAppenders

memoryAppenders($xSyncopeDomain)

Returns the list of memory appenders available in the current logging 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\LoggersApi(
    // 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->memoryAppenders($xSyncopeDomain);
} catch (Exception $e) {
    echo 'Exception when calling LoggersApi->memoryAppenders: ', $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]

read14

read14($type, $name, $xSyncopeDomain)

Returns logger with matching type and name.

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\LoggersApi(
    // 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 | LoggerType to be selected.
$name = 'name_example'; // string | Logger name to be read
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
type	string	LoggerType to be selected.
name	string	Logger name 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($key, $type, $xSyncopeDomain, $loggerTO)

Creates or updates (if existing) the logger with matching name.

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\LoggersApi(
    // 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 | Logger's key
$type = 'type_example'; // string | Logger to be created or updated
$xSyncopeDomain = 'Master'; // string | LoggerType to be selected
$loggerTO = new \OpenEuropa\SyncopePhpClient\Model\LoggerTO(); // \OpenEuropa\SyncopePhpClient\Model\LoggerTO | 

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

Parameters

Name	Type	Description	Notes
key	string	Logger's key
type	string	Logger to be created or updated
xSyncopeDomain	string	LoggerType to be selected	[default to 'Master']
loggerTO	\OpenEuropa\SyncopePhpClient\Model\LoggerTO

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

LoggersApi.md

Latest commit

History

LoggersApi.md

File metadata and controls

OpenEuropa\SyncopePhpClient\LoggersApi

delete1

Example

Parameters

Return type

Authorization

HTTP request headers

events

Example

Parameters

Return type

Authorization

HTTP request headers

getLastLogStatements

Example

Parameters

Return type

Authorization

HTTP request headers

list11

Example

Parameters

Return type

Authorization

HTTP request headers

memoryAppenders

Example

Parameters

Return type

Authorization

HTTP request headers

read14

Example

Parameters

Return type

Authorization

HTTP request headers

update

Example

Parameters

Return type

Authorization

HTTP request headers