omsorg/omsorgWeb/mitarbeiter-app/api-client-php/docs/Api/AuthApi.md

OmsorgCoreClient\AuthApi

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

Method	HTTP request	Description
apiAuthChangePasswordPost()	POST /api/auth/change-password
apiAuthForgotPasswordRequestPost()	POST /api/auth/forgot-password/request
apiAuthForgotPasswordResetPost()	POST /api/auth/forgot-password/reset
apiAuthForgotPasswordVerifyPost()	POST /api/auth/forgot-password/verify
apiAuthLoginPost()	POST /api/auth/login
apiAuthLogoutPost()	POST /api/auth/logout
apiAuthMeGet()	GET /api/auth/me
apiAuthPasswordPolicyGet()	GET /api/auth/password-policy
apiAuthRefreshPost()	POST /api/auth/refresh

apiAuthChangePasswordPost()

apiAuthChangePasswordPost($change_password_request)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$change_password_request = new \OmsorgCoreClient\Model\ChangePasswordRequest(); // \OmsorgCoreClient\Model\ChangePasswordRequest

try {
    $apiInstance->apiAuthChangePasswordPost($change_password_request);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->apiAuthChangePasswordPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
change_password_request	\OmsorgCoreClient\Model\ChangePasswordRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

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

apiAuthForgotPasswordRequestPost()

apiAuthForgotPasswordRequestPost($forgot_password_request_request): \OmsorgCoreClient\Model\ForgotPasswordRequestResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$forgot_password_request_request = new \OmsorgCoreClient\Model\ForgotPasswordRequestRequest(); // \OmsorgCoreClient\Model\ForgotPasswordRequestRequest

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

Parameters

Name	Type	Description	Notes
forgot_password_request_request	\OmsorgCoreClient\Model\ForgotPasswordRequestRequest		[optional]

Return type

\OmsorgCoreClient\Model\ForgotPasswordRequestResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiAuthForgotPasswordResetPost()

apiAuthForgotPasswordResetPost($forgot_password_reset_request)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$forgot_password_reset_request = new \OmsorgCoreClient\Model\ForgotPasswordResetRequest(); // \OmsorgCoreClient\Model\ForgotPasswordResetRequest

try {
    $apiInstance->apiAuthForgotPasswordResetPost($forgot_password_reset_request);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->apiAuthForgotPasswordResetPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
forgot_password_reset_request	\OmsorgCoreClient\Model\ForgotPasswordResetRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

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

apiAuthForgotPasswordVerifyPost()

apiAuthForgotPasswordVerifyPost($forgot_password_verify_request): \OmsorgCoreClient\Model\ForgotPasswordVerifyResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$forgot_password_verify_request = new \OmsorgCoreClient\Model\ForgotPasswordVerifyRequest(); // \OmsorgCoreClient\Model\ForgotPasswordVerifyRequest

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

Parameters

Name	Type	Description	Notes
forgot_password_verify_request	\OmsorgCoreClient\Model\ForgotPasswordVerifyRequest		[optional]

Return type

\OmsorgCoreClient\Model\ForgotPasswordVerifyResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiAuthLoginPost()

apiAuthLoginPost($login_request): \OmsorgCoreClient\Model\LoginResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$login_request = new \OmsorgCoreClient\Model\LoginRequest(); // \OmsorgCoreClient\Model\LoginRequest

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

Parameters

Name	Type	Description	Notes
login_request	\OmsorgCoreClient\Model\LoginRequest		[optional]

Return type

\OmsorgCoreClient\Model\LoginResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiAuthLogoutPost()

apiAuthLogoutPost($logout_request)

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$logout_request = new \OmsorgCoreClient\Model\LogoutRequest(); // \OmsorgCoreClient\Model\LogoutRequest

try {
    $apiInstance->apiAuthLogoutPost($logout_request);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->apiAuthLogoutPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
logout_request	\OmsorgCoreClient\Model\LogoutRequest		[optional]

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: Not defined

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

apiAuthMeGet()

apiAuthMeGet(): \OmsorgCoreClient\Model\MeResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OmsorgCoreClient\Model\MeResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiAuthPasswordPolicyGet()

apiAuthPasswordPolicyGet(): \OmsorgCoreClient\Model\PasswordPolicyResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OmsorgCoreClient\Model\PasswordPolicyResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiAuthRefreshPost()

apiAuthRefreshPost($refresh_request): \OmsorgCoreClient\Model\LoginResponse

Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\AuthApi(
    // 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
);
$refresh_request = new \OmsorgCoreClient\Model\RefreshRequest(); // \OmsorgCoreClient\Model\RefreshRequest

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

Parameters

Name	Type	Description	Notes
refresh_request	\OmsorgCoreClient\Model\RefreshRequest		[optional]

Return type

\OmsorgCoreClient\Model\LoginResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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