Skip to content

Latest commit

 

History

History
716 lines (493 loc) · 24.5 KB

ObjectUsergroupApi.md

File metadata and controls

716 lines (493 loc) · 24.5 KB

eZmaxAPI\ObjectUsergroupApi

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
usergroupCreateObjectV1() POST /1/object/usergroup Create a new Usergroup
usergroupEditObjectV1() PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
usergroupEditPermissionsV1() PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
usergroupEditUsergroupdelegationsV1() PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations Edit multiple Usergroupdelegations
usergroupEditUsergroupmembershipsV1() PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
usergroupGetAutocompleteV2() GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
usergroupGetListV1() GET /1/object/usergroup/getList Retrieve Usergroup list
usergroupGetObjectV2() GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
usergroupGetPermissionsV1() GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
usergroupGetUsergroupdelegationsV1() GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations Retrieve an existing Usergroup's Usergroupdelegations
usergroupGetUsergroupmembershipsV1() GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships

usergroupCreateObjectV1()

usergroupCreateObjectV1($usergroupCreateObjectV1Request): \eZmaxAPI\Model\UsergroupCreateObjectV1Response

Create a new Usergroup

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\ObjectUsergroupApi(
    // 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
);
$usergroupCreateObjectV1Request = new \eZmaxAPI\Model\UsergroupCreateObjectV1Request(); // \eZmaxAPI\Model\UsergroupCreateObjectV1Request

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

Parameters

Name Type Description Notes
usergroupCreateObjectV1Request \eZmaxAPI\Model\UsergroupCreateObjectV1Request

Return type

\eZmaxAPI\Model\UsergroupCreateObjectV1Response

Authorization

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]

usergroupEditObjectV1()

usergroupEditObjectV1($pkiUsergroupID, $usergroupEditObjectV1Request): \eZmaxAPI\Model\UsergroupEditObjectV1Response

Edit an existing Usergroup

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int
$usergroupEditObjectV1Request = new \eZmaxAPI\Model\UsergroupEditObjectV1Request(); // \eZmaxAPI\Model\UsergroupEditObjectV1Request

try {
    $result = $apiInstance->usergroupEditObjectV1($pkiUsergroupID, $usergroupEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditObjectV1Request \eZmaxAPI\Model\UsergroupEditObjectV1Request

Return type

\eZmaxAPI\Model\UsergroupEditObjectV1Response

Authorization

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]

usergroupEditPermissionsV1()

usergroupEditPermissionsV1($pkiUsergroupID, $usergroupEditPermissionsV1Request): \eZmaxAPI\Model\UsergroupEditPermissionsV1Response

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int
$usergroupEditPermissionsV1Request = new \eZmaxAPI\Model\UsergroupEditPermissionsV1Request(); // \eZmaxAPI\Model\UsergroupEditPermissionsV1Request

try {
    $result = $apiInstance->usergroupEditPermissionsV1($pkiUsergroupID, $usergroupEditPermissionsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupEditPermissionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditPermissionsV1Request \eZmaxAPI\Model\UsergroupEditPermissionsV1Request

Return type

\eZmaxAPI\Model\UsergroupEditPermissionsV1Response

Authorization

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]

usergroupEditUsergroupdelegationsV1()

usergroupEditUsergroupdelegationsV1($pkiUsergroupID, $usergroupEditUsergroupdelegationsV1Request): \eZmaxAPI\Model\UsergroupEditUsergroupdelegationsV1Response

Edit multiple Usergroupdelegations

Edit multiple Usergroupdelegations

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int
$usergroupEditUsergroupdelegationsV1Request = new \eZmaxAPI\Model\UsergroupEditUsergroupdelegationsV1Request(); // \eZmaxAPI\Model\UsergroupEditUsergroupdelegationsV1Request

try {
    $result = $apiInstance->usergroupEditUsergroupdelegationsV1($pkiUsergroupID, $usergroupEditUsergroupdelegationsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupEditUsergroupdelegationsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditUsergroupdelegationsV1Request \eZmaxAPI\Model\UsergroupEditUsergroupdelegationsV1Request

Return type

\eZmaxAPI\Model\UsergroupEditUsergroupdelegationsV1Response

Authorization

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]

usergroupEditUsergroupmembershipsV1()

usergroupEditUsergroupmembershipsV1($pkiUsergroupID, $usergroupEditUsergroupmembershipsV1Request): \eZmaxAPI\Model\UsergroupEditUsergroupmembershipsV1Response

Edit multiple Usergroupmemberships

Using this endpoint, you can edit multiple Usergroupmemberships at the same time.

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int
$usergroupEditUsergroupmembershipsV1Request = new \eZmaxAPI\Model\UsergroupEditUsergroupmembershipsV1Request(); // \eZmaxAPI\Model\UsergroupEditUsergroupmembershipsV1Request

try {
    $result = $apiInstance->usergroupEditUsergroupmembershipsV1($pkiUsergroupID, $usergroupEditUsergroupmembershipsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupEditUsergroupmembershipsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiUsergroupID int
usergroupEditUsergroupmembershipsV1Request \eZmaxAPI\Model\UsergroupEditUsergroupmembershipsV1Request

Return type

\eZmaxAPI\Model\UsergroupEditUsergroupmembershipsV1Response

Authorization

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]

usergroupGetAutocompleteV2()

usergroupGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\UsergroupGetAutocompleteV2Response

Retrieve Usergroups and IDs

Get the list of Usergroup 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\ObjectUsergroupApi(
    // 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 Usergroups 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->usergroupGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sSelector string The type of Usergroups 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\UsergroupGetAutocompleteV2Response

Authorization

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]

usergroupGetListV1()

usergroupGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\UsergroupGetListV1Response

Retrieve Usergroup list

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\ObjectUsergroupApi(
    // 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->usergroupGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupApi->usergroupGetListV1: ', $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\UsergroupGetListV1Response

Authorization

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]

usergroupGetObjectV2()

usergroupGetObjectV2($pkiUsergroupID): \eZmaxAPI\Model\UsergroupGetObjectV2Response

Retrieve an existing Usergroup

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

\eZmaxAPI\Model\UsergroupGetObjectV2Response

Authorization

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]

usergroupGetPermissionsV1()

usergroupGetPermissionsV1($pkiUsergroupID): \eZmaxAPI\Model\UsergroupGetPermissionsV1Response

Retrieve an existing Usergroup's Permissions

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

\eZmaxAPI\Model\UsergroupGetPermissionsV1Response

Authorization

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]

usergroupGetUsergroupdelegationsV1()

usergroupGetUsergroupdelegationsV1($pkiUsergroupID): \eZmaxAPI\Model\UsergroupGetUsergroupdelegationsV1Response

Retrieve an existing Usergroup's Usergroupdelegations

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

\eZmaxAPI\Model\UsergroupGetUsergroupdelegationsV1Response

Authorization

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]

usergroupGetUsergroupmembershipsV1()

usergroupGetUsergroupmembershipsV1($pkiUsergroupID): \eZmaxAPI\Model\UsergroupGetUsergroupmembershipsV1Response

Retrieve an existing Usergroup's Usergroupmemberships

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\ObjectUsergroupApi(
    // 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
);
$pkiUsergroupID = 56; // int

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

Parameters

Name Type Description Notes
pkiUsergroupID int

Return type

\eZmaxAPI\Model\UsergroupGetUsergroupmembershipsV1Response

Authorization

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]