eZmaxAPI\ObjectAuthenticationexternalApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method	HTTP request	Description
authenticationexternalCreateObjectV1()	POST /1/object/authenticationexternal	Create a new Authenticationexternal
authenticationexternalDeleteObjectV1()	DELETE /1/object/authenticationexternal/{pkiAuthenticationexternalID}	Delete an existing Authenticationexternal
authenticationexternalEditObjectV1()	PUT /1/object/authenticationexternal/{pkiAuthenticationexternalID}	Edit an existing Authenticationexternal
authenticationexternalGetAutocompleteV2()	GET /2/object/authenticationexternal/getAutocomplete/{sSelector}	Retrieve Authenticationexternals and IDs
authenticationexternalGetListV1()	GET /1/object/authenticationexternal/getList	Retrieve Authenticationexternal list
authenticationexternalGetObjectV2()	GET /2/object/authenticationexternal/{pkiAuthenticationexternalID}	Retrieve an existing Authenticationexternal
authenticationexternalResetAuthorizationV1()	POST /1/object/authenticationexternal/{pkiAuthenticationexternalID}/resetAuthorization	Reset the Authenticationexternal authorization

`authenticationexternalCreateObjectV1()`

authenticationexternalCreateObjectV1($authenticationexternalCreateObjectV1Request): \eZmaxAPI\Model\AuthenticationexternalCreateObjectV1Response

Create a new Authenticationexternal

The endpoint allows to create one or many elements at once.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$authenticationexternalCreateObjectV1Request = new \eZmaxAPI\Model\AuthenticationexternalCreateObjectV1Request(); // \eZmaxAPI\Model\AuthenticationexternalCreateObjectV1Request

try {
    $result = $apiInstance->authenticationexternalCreateObjectV1($authenticationexternalCreateObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalCreateObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
authenticationexternalCreateObjectV1Request	\eZmaxAPI\Model\AuthenticationexternalCreateObjectV1Request

Return type

\eZmaxAPI\Model\AuthenticationexternalCreateObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`authenticationexternalDeleteObjectV1()`

authenticationexternalDeleteObjectV1($pkiAuthenticationexternalID): \eZmaxAPI\Model\AuthenticationexternalDeleteObjectV1Response

Delete an existing Authenticationexternal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$pkiAuthenticationexternalID = 56; // int | The unique ID of the Authenticationexternal

try {
    $result = $apiInstance->authenticationexternalDeleteObjectV1($pkiAuthenticationexternalID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalDeleteObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiAuthenticationexternalID	int	The unique ID of the Authenticationexternal

Return type

\eZmaxAPI\Model\AuthenticationexternalDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`authenticationexternalEditObjectV1()`

authenticationexternalEditObjectV1($pkiAuthenticationexternalID, $authenticationexternalEditObjectV1Request): \eZmaxAPI\Model\AuthenticationexternalEditObjectV1Response

Edit an existing Authenticationexternal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$pkiAuthenticationexternalID = 56; // int | The unique ID of the Authenticationexternal
$authenticationexternalEditObjectV1Request = new \eZmaxAPI\Model\AuthenticationexternalEditObjectV1Request(); // \eZmaxAPI\Model\AuthenticationexternalEditObjectV1Request

try {
    $result = $apiInstance->authenticationexternalEditObjectV1($pkiAuthenticationexternalID, $authenticationexternalEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiAuthenticationexternalID	int	The unique ID of the Authenticationexternal
authenticationexternalEditObjectV1Request	\eZmaxAPI\Model\AuthenticationexternalEditObjectV1Request

Return type

\eZmaxAPI\Model\AuthenticationexternalEditObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`authenticationexternalGetAutocompleteV2()`

authenticationexternalGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\AuthenticationexternalGetAutocompleteV2Response

Retrieve Authenticationexternals and IDs

Get the list of Authenticationexternal to be used in a dropdown or autocomplete control.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$sSelector = 'sSelector_example'; // string | The type of Authenticationexternals to return
$eFilterActive = 'Active'; // string | Specify which results we want to display.
$sQuery = 'sQuery_example'; // string | Allow to filter the returned results
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage

try {
    $result = $apiInstance->authenticationexternalGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sSelector	string	The type of Authenticationexternals to return
eFilterActive	string	Specify which results we want to display.	[optional] [default to 'Active']
sQuery	string	Allow to filter the returned results	[optional]
acceptLanguage	\eZmaxAPI\Model\HeaderAcceptLanguage		[optional]

Return type

\eZmaxAPI\Model\AuthenticationexternalGetAutocompleteV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`authenticationexternalGetListV1()`

authenticationexternalGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\AuthenticationexternalGetListV1Response

Retrieve Authenticationexternal list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eAuthenticationexternalType | Salesforce
SalesforceSandbox |

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->authenticationexternalGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
eOrderBy	string	Specify how you want the results to be sorted	[optional]
iRowMax	int		[optional]
iRowOffset	int		[optional] [default to 0]
acceptLanguage	\eZmaxAPI\Model\HeaderAcceptLanguage		[optional]
sFilter	string		[optional]

Return type

\eZmaxAPI\Model\AuthenticationexternalGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

`authenticationexternalGetObjectV2()`

authenticationexternalGetObjectV2($pkiAuthenticationexternalID): \eZmaxAPI\Model\AuthenticationexternalGetObjectV2Response

Retrieve an existing Authenticationexternal

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$pkiAuthenticationexternalID = 56; // int | The unique ID of the Authenticationexternal

try {
    $result = $apiInstance->authenticationexternalGetObjectV2($pkiAuthenticationexternalID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalGetObjectV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiAuthenticationexternalID	int	The unique ID of the Authenticationexternal

Return type

\eZmaxAPI\Model\AuthenticationexternalGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`authenticationexternalResetAuthorizationV1()`

authenticationexternalResetAuthorizationV1($pkiAuthenticationexternalID, $body): \eZmaxAPI\Model\AuthenticationexternalResetAuthorizationV1Response

Reset the Authenticationexternal authorization

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectAuthenticationexternalApi(
    // 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
);
$pkiAuthenticationexternalID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->authenticationexternalResetAuthorizationV1($pkiAuthenticationexternalID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectAuthenticationexternalApi->authenticationexternalResetAuthorizationV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiAuthenticationexternalID	int
body	object

Return type

\eZmaxAPI\Model\AuthenticationexternalResetAuthorizationV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

ObjectAuthenticationexternalApi.md

Latest commit

History

ObjectAuthenticationexternalApi.md

File metadata and controls

eZmaxAPI\ObjectAuthenticationexternalApi

authenticationexternalCreateObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalDeleteObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalEditObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalGetAutocompleteV2()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalGetListV1()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalGetObjectV2()

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationexternalResetAuthorizationV1()

Example

Parameters

Return type

Authorization

HTTP request headers

`authenticationexternalCreateObjectV1()`

`authenticationexternalDeleteObjectV1()`

`authenticationexternalEditObjectV1()`

`authenticationexternalGetAutocompleteV2()`

`authenticationexternalGetListV1()`

`authenticationexternalGetObjectV2()`

`authenticationexternalResetAuthorizationV1()`