Alfaview\AuthenticationServiceApi

All URIs are relative to https://localhost

Method	HTTP request	Description
accessTokenInformation	POST /accessTokenInformation
authenticate	POST /authenticate
authenticationCreate	POST /authenticationCreate
authenticationInformation	POST /authenticationInformation
authenticationUpdate	POST /authenticationUpdate
createMagicToken	POST /createMagicToken
isAuthenticated	POST /isAuthenticated
listAuthentications	POST /listAuthentications
listIdentityProviders	POST /listIdentityProviders
requestPasswordReset	POST /requestPasswordReset
sendCompanyDeletionEmail	POST /sendCompanyDeletionEmail
signAccessToken	POST /signAccessToken

accessTokenInformation

\Alfaview\Model\AuthenticationAuthenticationReply accessTokenInformation($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationAccessTokenInformationRequest(); // \Alfaview\Model\AuthenticationAccessTokenInformationRequest | 

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationAccessTokenInformationRequest

Return type

\Alfaview\Model\AuthenticationAuthenticationReply

Authorization

No authorization required

HTTP request headers

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

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

authenticate

\Alfaview\Model\AuthenticationAuthenticationReply authenticate($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationAuthenticationRequest(); // \Alfaview\Model\AuthenticationAuthenticationRequest | * AuthenticationRequest contains everything needed to authenticate a user on our platform.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationAuthenticationRequest	* AuthenticationRequest contains everything needed to authenticate a user on our platform.

Return type

\Alfaview\Model\AuthenticationAuthenticationReply

Authorization

No authorization required

HTTP request headers

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

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

authenticationCreate

\Alfaview\Model\AuthenticationAuthenticationCreateReply authenticationCreate($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationAuthenticationCreateRequest(); // \Alfaview\Model\AuthenticationAuthenticationCreateRequest | AuthenticationCreateRequest carries all the required information to create authentication methods for a user. This is only used if the user ID is not known and should be picked by the authentication service, otherwise use the AuthenticationUpdateRequest.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationAuthenticationCreateRequest	AuthenticationCreateRequest carries all the required information to create authentication methods for a user. This is only used if the user ID is not known and should be picked by the authentication service, otherwise use the AuthenticationUpdateRequest.

Return type

\Alfaview\Model\AuthenticationAuthenticationCreateReply

Authorization

No authorization required

HTTP request headers

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

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

authenticationInformation

\Alfaview\Model\AuthenticationAuthenticationInformationReply authenticationInformation($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationAuthenticationInformationRequest(); // \Alfaview\Model\AuthenticationAuthenticationInformationRequest | * Use AuthenticationInformationRequest to find out about a user's authentication methods and their permissions.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationAuthenticationInformationRequest	* Use AuthenticationInformationRequest to find out about a user's authentication methods and their permissions.

Return type

\Alfaview\Model\AuthenticationAuthenticationInformationReply

Authorization

No authorization required

HTTP request headers

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

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

authenticationUpdate

\Alfaview\Model\AuthenticationAuthenticationUpdateReply authenticationUpdate($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationAuthenticationUpdateRequest(); // \Alfaview\Model\AuthenticationAuthenticationUpdateRequest | AuthenticationUpdateRequest carries all the required information on how to update a user's authentication methods.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationAuthenticationUpdateRequest	AuthenticationUpdateRequest carries all the required information on how to update a user's authentication methods.

Return type

\Alfaview\Model\AuthenticationAuthenticationUpdateReply

Authorization

No authorization required

HTTP request headers

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

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

createMagicToken

\Alfaview\Model\AuthenticationCreateMagicTokenReply createMagicToken($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationCreateMagicTokenRequest(); // \Alfaview\Model\AuthenticationCreateMagicTokenRequest | * CreateMagicTokenRequest is used to create a magic token from a given access token (and possibly even a refresh token, see the description of the `refreshToken` field). A magic token created via such a request will be valid for a very short amount of time (minutes) and is one-time use only.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationCreateMagicTokenRequest	* CreateMagicTokenRequest is used to create a magic token from a given access token (and possibly even a refresh token, see the description of the `refreshToken` field). A magic token created via such a request will be valid for a very short amount of time (minutes) and is one-time use only.

Return type

\Alfaview\Model\AuthenticationCreateMagicTokenReply

Authorization

No authorization required

HTTP request headers

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

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

isAuthenticated

\Alfaview\Model\CommonReplyInfo isAuthenticated($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\CommonAccessInfo(); // \Alfaview\Model\CommonAccessInfo | 

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\CommonAccessInfo

Return type

\Alfaview\Model\CommonReplyInfo

Authorization

No authorization required

HTTP request headers

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

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

listAuthentications

\Alfaview\Model\AuthenticationListAuthenticationsReply listAuthentications($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationListAuthenticationsRequest(); // \Alfaview\Model\AuthenticationListAuthenticationsRequest | * ListAuthenticationsRequest is used to list authentication methods. You may list by a variety of different attributes – these are also combinable, i.e. requesting the authentication methods of a list of user IDs of a specific key type in a specific state (pending/activated/locked). Depending on your permissions, some of these will be invalid or disallowed. For normal users only their own authentication methods will be returned (matching the user ID in their token).

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationListAuthenticationsRequest	* ListAuthenticationsRequest is used to list authentication methods. You may list by a variety of different attributes – these are also combinable, i.e. requesting the authentication methods of a list of user IDs of a specific key type in a specific state (pending/activated/locked). Depending on your permissions, some of these will be invalid or disallowed. For normal users only their own authentication methods will be returned (matching the user ID in their token).

Return type

\Alfaview\Model\AuthenticationListAuthenticationsReply

Authorization

No authorization required

HTTP request headers

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

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

listIdentityProviders

\Alfaview\Model\AuthenticationListIdentityProvidersReply listIdentityProviders($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationListIdentityProvidersRequest(); // \Alfaview\Model\AuthenticationListIdentityProvidersRequest | * ListIdentityProvidersRequest is used to query for all registered identity providers.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationListIdentityProvidersRequest	* ListIdentityProvidersRequest is used to query for all registered identity providers.

Return type

\Alfaview\Model\AuthenticationListIdentityProvidersReply

Authorization

No authorization required

HTTP request headers

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

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

requestPasswordReset

\Alfaview\Model\AuthenticationPasswordResetReply requestPasswordReset($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationPasswordResetRequest(); // \Alfaview\Model\AuthenticationPasswordResetRequest | * PasswordResetRequest is used to reset a user's password. Although it is an implementation detail it is encouraged to only return the password reset token in the response if the user doing the resetting (i.e. an admin user) is part of the same company as the user whose password is being reset. Otherwise, the authentication service should handle emailing the password reset token itself.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationPasswordResetRequest	* PasswordResetRequest is used to reset a user's password. Although it is an implementation detail it is encouraged to only return the password reset token in the response if the user doing the resetting (i.e. an admin user) is part of the same company as the user whose password is being reset. Otherwise, the authentication service should handle emailing the password reset token itself.

Return type

\Alfaview\Model\AuthenticationPasswordResetReply

Authorization

No authorization required

HTTP request headers

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

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

sendCompanyDeletionEmail

\Alfaview\Model\AuthenticationSendCompanyDeletionEmailReply sendCompanyDeletionEmail($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationSendCompanyDeletionEmailRequest(); // \Alfaview\Model\AuthenticationSendCompanyDeletionEmailRequest | * SendCompanyDeletionEmailRequest requests sending an email to the company owner to delete their company. The email will contain a link to delete the company via the alfaview web app. The requesting user must be the company owner.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationSendCompanyDeletionEmailRequest	* SendCompanyDeletionEmailRequest requests sending an email to the company owner to delete their company. The email will contain a link to delete the company via the alfaview web app. The requesting user must be the company owner.

Return type

\Alfaview\Model\AuthenticationSendCompanyDeletionEmailReply

Authorization

No authorization required

HTTP request headers

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

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

signAccessToken

\Alfaview\Model\AuthenticationAuthenticationReply signAccessToken($body)

Example

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

$apiInstance = new Alfaview\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()
);
$body = new \Alfaview\Model\AuthenticationSignAccessTokenRequest(); // \Alfaview\Model\AuthenticationSignAccessTokenRequest | * SignAccessTokenRequest is used to sign credentials without authenticating.

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

Parameters

Name	Type	Description	Notes
body	\Alfaview\Model\AuthenticationSignAccessTokenRequest	* SignAccessTokenRequest is used to sign credentials without authenticating.

Return type

\Alfaview\Model\AuthenticationAuthenticationReply

Authorization

No authorization required

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

AuthenticationServiceApi.md

Latest commit

History

AuthenticationServiceApi.md

File metadata and controls

Alfaview\AuthenticationServiceApi

accessTokenInformation

Example

Parameters

Return type

Authorization

HTTP request headers

authenticate

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationCreate

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationInformation

Example

Parameters

Return type

Authorization

HTTP request headers

authenticationUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

createMagicToken

Example

Parameters

Return type

Authorization

HTTP request headers

isAuthenticated

Example

Parameters

Return type

Authorization

HTTP request headers

listAuthentications

Example

Parameters

Return type

Authorization

HTTP request headers

listIdentityProviders

Example

Parameters

Return type

Authorization

HTTP request headers

requestPasswordReset

Example

Parameters

Return type

Authorization

HTTP request headers

sendCompanyDeletionEmail

Example

Parameters

Return type

Authorization

HTTP request headers

signAccessToken

Example

Parameters

Return type

Authorization

HTTP request headers