eZmaxAPI\ObjectUserApi

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
userCreateObjectV1()	POST /1/object/user	Create a new User
userCreateObjectV2()	POST /2/object/user	Create a new User
userEditColleaguesV2()	PUT /2/object/user/{pkiUserID}/editColleagues	Edit multiple Colleagues
userEditObjectV1()	PUT /1/object/user/{pkiUserID}	Edit an existing User
userEditPermissionsV1()	PUT /1/object/user/{pkiUserID}/editPermissions	Edit multiple Permissions
userGetApikeysV1()	GET /1/object/user/{pkiUserID}/getApikeys	Retrieve an existing User's Apikeys
userGetAutocompleteV2()	GET /2/object/user/getAutocomplete/{sSelector}	Retrieve Users and IDs
userGetColleaguesV2()	GET /2/object/user/{pkiUserID}/getColleagues	Retrieve an existing User's Colleagues
userGetEffectivePermissionsV1()	GET /1/object/user/{pkiUserID}/getEffectivePermissions	Retrieve an existing User's Effective Permissions
userGetListV1()	GET /1/object/user/getList	Retrieve User list
userGetObjectV2()	GET /2/object/user/{pkiUserID}	Retrieve an existing User
userGetPermissionsV1()	GET /1/object/user/{pkiUserID}/getPermissions	Retrieve an existing User's Permissions
userGetSubnetsV1()	GET /1/object/user/{pkiUserID}/getSubnets	Retrieve an existing User's Subnets
userGetUsergroupexternalsV1()	GET /1/object/user/{pkiUserID}/getUsergroupexternals	Get User's Usergroupexternals
userGetUsergroupsV1()	GET /1/object/user/{pkiUserID}/getUsergroups	Get User's Usergroups
userSendPasswordResetV1()	POST /1/object/user/{pkiUserID}/sendPasswordReset	Send password reset

`userCreateObjectV1()`

userCreateObjectV1($userCreateObjectV1Request): \eZmaxAPI\Model\UserCreateObjectV1Response

Create a new User

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\ObjectUserApi(
    // 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
);
$userCreateObjectV1Request = new \eZmaxAPI\Model\UserCreateObjectV1Request(); // \eZmaxAPI\Model\UserCreateObjectV1Request

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

Parameters

Name	Type	Description	Notes
userCreateObjectV1Request	\eZmaxAPI\Model\UserCreateObjectV1Request

Return type

\eZmaxAPI\Model\UserCreateObjectV1Response

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]

`userCreateObjectV2()`

userCreateObjectV2($userCreateObjectV2Request): \eZmaxAPI\Model\UserCreateObjectV2Response

Create a new User

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\ObjectUserApi(
    // 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
);
$userCreateObjectV2Request = new \eZmaxAPI\Model\UserCreateObjectV2Request(); // \eZmaxAPI\Model\UserCreateObjectV2Request

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

Parameters

Name	Type	Description	Notes
userCreateObjectV2Request	\eZmaxAPI\Model\UserCreateObjectV2Request

Return type

\eZmaxAPI\Model\UserCreateObjectV2Response

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]

`userEditColleaguesV2()`

userEditColleaguesV2($pkiUserID, $userEditColleaguesV2Request): \eZmaxAPI\Model\UserEditColleaguesV2Response

Edit multiple Colleagues

Using this endpoint, you can edit multiple Colleagues 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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int
$userEditColleaguesV2Request = new \eZmaxAPI\Model\UserEditColleaguesV2Request(); // \eZmaxAPI\Model\UserEditColleaguesV2Request

try {
    $result = $apiInstance->userEditColleaguesV2($pkiUserID, $userEditColleaguesV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUserApi->userEditColleaguesV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiUserID	int
userEditColleaguesV2Request	\eZmaxAPI\Model\UserEditColleaguesV2Request

Return type

\eZmaxAPI\Model\UserEditColleaguesV2Response

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]

`userEditObjectV1()`

userEditObjectV1($pkiUserID, $userEditObjectV1Request): \eZmaxAPI\Model\UserEditObjectV1Response

Edit an existing User

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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int | The unique ID of the User
$userEditObjectV1Request = new \eZmaxAPI\Model\UserEditObjectV1Request(); // \eZmaxAPI\Model\UserEditObjectV1Request

try {
    $result = $apiInstance->userEditObjectV1($pkiUserID, $userEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUserApi->userEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiUserID	int	The unique ID of the User
userEditObjectV1Request	\eZmaxAPI\Model\UserEditObjectV1Request

Return type

\eZmaxAPI\Model\UserEditObjectV1Response

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]

`userEditPermissionsV1()`

userEditPermissionsV1($pkiUserID, $userEditPermissionsV1Request): \eZmaxAPI\Model\UserEditPermissionsV1Response

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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int
$userEditPermissionsV1Request = new \eZmaxAPI\Model\UserEditPermissionsV1Request(); // \eZmaxAPI\Model\UserEditPermissionsV1Request

try {
    $result = $apiInstance->userEditPermissionsV1($pkiUserID, $userEditPermissionsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUserApi->userEditPermissionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pkiUserID	int
userEditPermissionsV1Request	\eZmaxAPI\Model\UserEditPermissionsV1Request

Return type

\eZmaxAPI\Model\UserEditPermissionsV1Response

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]

`userGetApikeysV1()`

userGetApikeysV1($pkiUserID): \eZmaxAPI\Model\UserGetApikeysV1Response

Retrieve an existing User's Apikeys

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetApikeysV1Response

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]

`userGetAutocompleteV2()`

userGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\UserGetAutocompleteV2Response

Retrieve Users and IDs

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

Parameters

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

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]

`userGetColleaguesV2()`

userGetColleaguesV2($pkiUserID): \eZmaxAPI\Model\UserGetColleaguesV2Response

Retrieve an existing User's Colleagues

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetColleaguesV2Response

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]

`userGetEffectivePermissionsV1()`

userGetEffectivePermissionsV1($pkiUserID): \eZmaxAPI\Model\UserGetEffectivePermissionsV1Response

Retrieve an existing User's Effective Permissions

Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to.

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetEffectivePermissionsV1Response

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]

`userGetListV1()`

userGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\UserGetListV1Response

Retrieve User list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid |

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

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]

`userGetObjectV2()`

userGetObjectV2($pkiUserID): \eZmaxAPI\Model\UserGetObjectV2Response

Retrieve an existing User

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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int | The unique ID of the User

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

Parameters

Name	Type	Description	Notes
pkiUserID	int	The unique ID of the User

Return type

\eZmaxAPI\Model\UserGetObjectV2Response

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]

`userGetPermissionsV1()`

userGetPermissionsV1($pkiUserID): \eZmaxAPI\Model\UserGetPermissionsV1Response

Retrieve an existing User'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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetPermissionsV1Response

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]

`userGetSubnetsV1()`

userGetSubnetsV1($pkiUserID): \eZmaxAPI\Model\UserGetSubnetsV1Response

Retrieve an existing User's Subnets

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetSubnetsV1Response

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]

`userGetUsergroupexternalsV1()`

userGetUsergroupexternalsV1($pkiUserID): \eZmaxAPI\Model\UserGetUsergroupexternalsV1Response

Get User's Usergroupexternals

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetUsergroupexternalsV1Response

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]

`userGetUsergroupsV1()`

userGetUsergroupsV1($pkiUserID): \eZmaxAPI\Model\UserGetUsergroupsV1Response

Get User's Usergroups

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

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

Parameters

Name	Type	Description	Notes
pkiUserID	int

Return type

\eZmaxAPI\Model\UserGetUsergroupsV1Response

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]

`userSendPasswordResetV1()`

userSendPasswordResetV1($pkiUserID, $body): \eZmaxAPI\Model\UserSendPasswordResetV1Response

Send password reset

Send the password reset email

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\ObjectUserApi(
    // 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
);
$pkiUserID = 56; // int
$body = array('key' => new \stdClass); // object

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

Parameters

Name	Type	Description	Notes
pkiUserID	int
body	object

Return type

\eZmaxAPI\Model\UserSendPasswordResetV1Response

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

ObjectUserApi.md

Latest commit

History

ObjectUserApi.md

File metadata and controls

eZmaxAPI\ObjectUserApi

userCreateObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userCreateObjectV2()

Example

Parameters

Return type

Authorization

HTTP request headers

userEditColleaguesV2()

Example

Parameters

Return type

Authorization

HTTP request headers

userEditObjectV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userEditPermissionsV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetApikeysV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetAutocompleteV2()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetColleaguesV2()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetEffectivePermissionsV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetListV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetObjectV2()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetPermissionsV1()

Example

Parameters

Return type

Authorization

HTTP request headers

userGetSubnetsV1()

`userCreateObjectV1()`

`userCreateObjectV2()`

`userEditColleaguesV2()`

`userEditObjectV1()`

`userEditPermissionsV1()`

`userGetApikeysV1()`

`userGetAutocompleteV2()`

`userGetColleaguesV2()`

`userGetEffectivePermissionsV1()`

`userGetListV1()`

`userGetObjectV2()`

`userGetPermissionsV1()`

`userGetSubnetsV1()`

`userGetUsergroupexternalsV1()`

`userGetUsergroupsV1()`

`userSendPasswordResetV1()`