OpenAPI\Client\AuthenticationServiceApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
usersAuthenticationRestCreatetokenPost()	POST /users/authentication/rest/createtoken
usersAuthenticationRestDeletetokensPost()	POST /users/authentication/rest/deletetokens
usersAuthenticationRestEdittokenPost()	POST /users/authentication/rest/edittoken
usersAuthenticationRestGetpolicymethodsPost()	POST /users/authentication/rest/getpolicymethods
usersAuthenticationRestGetsessionsPost()	POST /users/authentication/rest/getsessions
usersAuthenticationRestGettokenapilistPost()	POST /users/authentication/rest/gettokenapilist
usersAuthenticationRestGettokensPost()	POST /users/authentication/rest/gettokens
usersAuthenticationRestGettokentemplatesPost()	POST /users/authentication/rest/gettokentemplates
usersAuthenticationRestRegeneratetokenPost()	POST /users/authentication/rest/regeneratetoken
usersAuthenticationRestSigninPost()	POST /users/authentication/rest/signin
usersAuthenticationRestSignoutPost()	POST /users/authentication/rest/signout
usersAuthenticationRestSignoutsessionsPost()	POST /users/authentication/rest/signoutsessions

`usersAuthenticationRestCreatetokenPost()`

usersAuthenticationRestCreatetokenPost($description, $tokenTemplate, $password, $expiresAt, $apiList): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Creates token, which allows to execute specific API methods, list of these methods can be found by executing GetTokenApiList.

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$description = 'description_example'; // string
$tokenTemplate = 'tokenTemplate_example'; // string
$password = 'password_example'; // string
$expiresAt = 'expiresAt_example'; // string
$apiList = 'apiList_example'; // string

try {
    $result = $apiInstance->usersAuthenticationRestCreatetokenPost($description, $tokenTemplate, $password, $expiresAt, $apiList);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestCreatetokenPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
description	string
tokenTemplate	string	[optional]
password	string	[optional]
expiresAt	string	[optional]
apiList	string	[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestDeletetokensPost()`

usersAuthenticationRestDeletetokensPost($ids, $password): \OpenAPI\Client\Model\ComHivextApiResponse

Deletes tokens with given ids.

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$ids = 'ids_example'; // string
$password = 'password_example'; // string

try {
    $result = $apiInstance->usersAuthenticationRestDeletetokensPost($ids, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestDeletetokensPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
ids	string
password	string		[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestEdittokenPost()`

usersAuthenticationRestEdittokenPost($id, $tokenTemplate, $password, $description, $expiresAt, $apiList): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Edits already created token.
Returns:
- ApiListItem (String) is a name of the appropriate API method, which can be authenticated with the current token

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$id = 56; // int
$tokenTemplate = 'tokenTemplate_example'; // string
$password = 'password_example'; // string
$description = 'description_example'; // string
$expiresAt = 'expiresAt_example'; // string
$apiList = 'apiList_example'; // string

try {
    $result = $apiInstance->usersAuthenticationRestEdittokenPost($id, $tokenTemplate, $password, $description, $expiresAt, $apiList);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestEdittokenPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
id	int
tokenTemplate	string	[optional]
password	string	[optional]
description	string	[optional]
expiresAt	string	[optional]
apiList	string	[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestGetpolicymethodsPost()`

usersAuthenticationRestGetpolicymethodsPost($uniqueName): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$uniqueName = 'uniqueName_example'; // string

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

Parameters

Name	Type	Description	Notes
uniqueName	string		[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestGetsessionsPost()`

usersAuthenticationRestGetsessionsPost(): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseSessionsResponse

Returns list of sessions

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseSessionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestGettokenapilistPost()`

usersAuthenticationRestGettokenapilistPost($search, $showPrivate): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Returns list of API methods that can be used with tokens
Returns:
- ApiListItem (String) is a name of the appropriate API method, which can be authenticated with the current token

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$search = 'search_example'; // string
$showPrivate = True; // bool

try {
    $result = $apiInstance->usersAuthenticationRestGettokenapilistPost($search, $showPrivate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestGettokenapilistPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
search	string		[optional]
showPrivate	bool		[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenPermissionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestGettokensPost()`

usersAuthenticationRestGettokensPost($ids): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokensResponse

Returns info about tokens with given ids.
Returns:
- ApiListItem (String) is a name of the appropriate API method, which can be authenticated with the current token

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$ids = 'ids_example'; // string

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

Parameters

Name	Type	Description	Notes
ids	string		[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokensResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestGettokentemplatesPost()`

usersAuthenticationRestGettokentemplatesPost(): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenTemplatesResponse

Returns list of token templates

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenTemplatesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestRegeneratetokenPost()`

usersAuthenticationRestRegeneratetokenPost($id, $password): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Generates new value of token, previous one becomes not valid.
Returns:
- ApiListItem (String) is a name of the appropriate API method, which can be authenticated with the current token

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$id = 56; // int
$password = 'password_example'; // string

try {
    $result = $apiInstance->usersAuthenticationRestRegeneratetokenPost($id, $password);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestRegeneratetokenPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int
password	string		[optional]

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseApiTokenResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestSigninPost()`

usersAuthenticationRestSigninPost($password, $login): \OpenAPI\Client\Model\ComHivextApiServerUsersResponseAuthenticationResponse

Creates a session for performing different actions within user account. This session is valid until the Signout method is called.

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$password = 'password_example'; // string
$login = 'login_example'; // string

try {
    $result = $apiInstance->usersAuthenticationRestSigninPost($password, $login);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationServiceApi->usersAuthenticationRestSigninPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
password	string
login	string

Return type

\OpenAPI\Client\Model\ComHivextApiServerUsersResponseAuthenticationResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestSignoutPost()`

usersAuthenticationRestSignoutPost(): \OpenAPI\Client\Model\ComHivextApiResponse

Breaks the session created while authentication.

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

`usersAuthenticationRestSignoutsessionsPost()`

usersAuthenticationRestSignoutsessionsPost($ids): \OpenAPI\Client\Model\ComHivextApiResponse

Breaks the sessions by ids.

Example

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



$apiInstance = new OpenAPI\Client\Api\AuthenticationServiceApi(
    // 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()
);
$ids = 'ids_example'; // string

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

Parameters

Name	Type	Description	Notes
ids	string

Return type

\OpenAPI\Client\Model\ComHivextApiResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

Files

AuthenticationServiceApi.md

Latest commit

History

AuthenticationServiceApi.md

File metadata and controls

OpenAPI\Client\AuthenticationServiceApi

usersAuthenticationRestCreatetokenPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestDeletetokensPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestEdittokenPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestGetpolicymethodsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestGetsessionsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestGettokenapilistPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestGettokensPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestGettokentemplatesPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestRegeneratetokenPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestSigninPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestSignoutPost()

Example

Parameters

Return type

Authorization

HTTP request headers

usersAuthenticationRestSignoutsessionsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`usersAuthenticationRestCreatetokenPost()`

`usersAuthenticationRestDeletetokensPost()`

`usersAuthenticationRestEdittokenPost()`

`usersAuthenticationRestGetpolicymethodsPost()`

`usersAuthenticationRestGetsessionsPost()`

`usersAuthenticationRestGettokenapilistPost()`

`usersAuthenticationRestGettokensPost()`

`usersAuthenticationRestGettokentemplatesPost()`

`usersAuthenticationRestRegeneratetokenPost()`

`usersAuthenticationRestSigninPost()`

`usersAuthenticationRestSignoutPost()`

`usersAuthenticationRestSignoutsessionsPost()`