OpenEuropa\SyncopePhpClient\SecurityQuestionsApi

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

Method	HTTP request	Description
create1	POST /securityQuestions	Creates a new security question.
delete1	DELETE /securityQuestions/{key}	Deletes the security question matching the provided key.
list26	GET /securityQuestions	Returns a list of all security questions.
read27	GET /securityQuestions/{key}	Returns security question with matching key.
readByUser	GET /securityQuestions/byUser/{username}	Ask for security question configured for the user matching the given username, if any.
update1	PUT /securityQuestions/{key}	Updates the security question matching the provided key.

create1

create1($xSyncopeDomain, $securityQuestionTO)

Creates a new security question.

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\SecurityQuestionsApi(
    // 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 | security question to be created
$securityQuestionTO = new \OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO(); // \OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO | 

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

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	security question to be created	[default to 'Master']
securityQuestionTO	\OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO

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 security question 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\SecurityQuestionsApi(
    // 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 | security question key to be deleted
$xSyncopeDomain = 'Master'; // string | username for which the security question is requested

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

Parameters

Name	Type	Description	Notes
key	string	security question key to be deleted
xSyncopeDomain	string	username for which the security question is requested	[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]

list26

list26($xSyncopeDomain)

Returns a list of all security questions.

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

read27

read27($key, $xSyncopeDomain)

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

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

Parameters

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

readByUser

readByUser($username, $xSyncopeDomain)

Ask for security question configured for the user matching the given username, if any.

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\SecurityQuestionsApi(
    // 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
);
$username = 'username_example'; // string | username for which the security question is requested
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
username	string	username for which the security question is requested
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]

update1

update1($key, $xSyncopeDomain, $securityQuestionTO)

Updates the security question 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\SecurityQuestionsApi(
    // 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 | SecurityQuestion's key
$xSyncopeDomain = 'Master'; // string | security question key to be deleted
$securityQuestionTO = new \OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO(); // \OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO | 

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

Parameters

Name	Type	Description	Notes
key	string	SecurityQuestion's key
xSyncopeDomain	string	security question key to be deleted	[default to 'Master']
securityQuestionTO	\OpenEuropa\SyncopePhpClient\Model\SecurityQuestionTO

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

SecurityQuestionsApi.md

Latest commit

History

SecurityQuestionsApi.md

File metadata and controls

OpenEuropa\SyncopePhpClient\SecurityQuestionsApi

create1

Example

Parameters

Return type

Authorization

HTTP request headers

delete1

Example

Parameters

Return type

Authorization

HTTP request headers

list26

Example

Parameters

Return type

Authorization

HTTP request headers

read27

Example

Parameters

Return type

Authorization

HTTP request headers

readByUser

Example

Parameters

Return type

Authorization

HTTP request headers

update1

Example

Parameters

Return type

Authorization

HTTP request headers