OpenEuropa\SyncopePhpClient\OIDCProvidersApi

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

Method	HTTP request	Description
create	POST /oidcclient/providers	Creates a new OIDC Provider.
createFromDiscovery	POST /oidcclient/providers/fromDiscovery	Creates a new OIDC Provider by using its Discovery Document.
delete1	DELETE /oidcclient/providers/{key}	Deletes the OIDC Provider with matching key.
getActionsClasses	GET /oidcclient/providers/actionsClasses	Returns the list of available OIDCProviderActions implementations.
list14	GET /oidcclient/providers	Returns a list of all defined OIDC Providers.
read17	GET /oidcclient/providers/{key}	Returns the OIDC Provider with matching key, if available.
update1	PUT /oidcclient/providers/{key}	Updates the OIDC Provider with matching key.

create

create($xSyncopeDomain, $oIDCProviderTO)

Creates a new OIDC Provider.

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\OIDCProvidersApi(
    // 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 | OpenID Connect Provider configuration to be stored
$oIDCProviderTO = new \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO(); // \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO | 

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

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	OpenID Connect Provider configuration to be stored	[default to 'Master']
oIDCProviderTO	\OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO		[optional]

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]

createFromDiscovery

createFromDiscovery($xSyncopeDomain, $oIDCProviderTO)

Creates a new OIDC Provider by using its Discovery Document.

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\OIDCProvidersApi(
    // 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 | OpenID Connect Provider configuration to be stored
$oIDCProviderTO = new \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO(); // \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO | 

try {
    $apiInstance->createFromDiscovery($xSyncopeDomain, $oIDCProviderTO);
} catch (Exception $e) {
    echo 'Exception when calling OIDCProvidersApi->createFromDiscovery: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
xSyncopeDomain	string	OpenID Connect Provider configuration to be stored	[default to 'Master']
oIDCProviderTO	\OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO		[optional]

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 OIDC Provider 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\OIDCProvidersApi(
    // 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 | OIDC Provider key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

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

getActionsClasses

getActionsClasses($xSyncopeDomain)

Returns the list of available OIDCProviderActions implementations.

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

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

list14

list14($xSyncopeDomain)

Returns a list of all defined OIDC Providers.

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

read17

read17($key, $xSyncopeDomain)

Returns the OIDC Provider with matching key, if available.

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\OIDCProvidersApi(
    // 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 | OIDC Provider's key
$xSyncopeDomain = 'Master'; // string | 

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

Parameters

Name	Type	Description	Notes
key	string	OIDC Provider's key
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, $oIDCProviderTO)

Updates the OIDC Provider 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\OIDCProvidersApi(
    // 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 | OIDC Provider's key
$xSyncopeDomain = 'Master'; // string | OIDC Provider key
$oIDCProviderTO = new \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO(); // \OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO | 

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

Parameters

Name	Type	Description	Notes
key	string	OIDC Provider's key
xSyncopeDomain	string	OIDC Provider key	[default to 'Master']
oIDCProviderTO	\OpenEuropa\SyncopePhpClient\Model\OIDCProviderTO

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

OIDCProvidersApi.md

Latest commit

History

OIDCProvidersApi.md

File metadata and controls

OpenEuropa\SyncopePhpClient\OIDCProvidersApi

create

Example

Parameters

Return type

Authorization

HTTP request headers

createFromDiscovery

Example

Parameters

Return type

Authorization

HTTP request headers

delete1

Example

Parameters

Return type

Authorization

HTTP request headers

getActionsClasses

Example

Parameters

Return type

Authorization

HTTP request headers

list14

Example

Parameters

Return type

Authorization

HTTP request headers

read17

Example

Parameters

Return type

Authorization

HTTP request headers

update1

Example

Parameters

Return type

Authorization

HTTP request headers