# openapi.api.AuthenticationApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to */api* Method | HTTP request | Description ------------- | ------------- | ------------- [**changePassword**](AuthenticationApi.md#changepassword) | **POST** /auth/change-password | [**getAuthDevices**](AuthenticationApi.md#getauthdevices) | **GET** /auth/devices | [**login**](AuthenticationApi.md#login) | **POST** /auth/login | [**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout | [**logoutAuthDevice**](AuthenticationApi.md#logoutauthdevice) | **DELETE** /auth/devices/{id} | [**logoutAuthDevices**](AuthenticationApi.md#logoutauthdevices) | **DELETE** /auth/devices | [**signUpAdmin**](AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up | [**validateAccessToken**](AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken | # **changePassword** > UserResponseDto changePassword(changePasswordDto) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); final changePasswordDto = ChangePasswordDto(); // ChangePasswordDto | try { final result = api_instance.changePassword(changePasswordDto); print(result); } catch (e) { print('Exception when calling AuthenticationApi->changePassword: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **changePasswordDto** | [**ChangePasswordDto**](ChangePasswordDto.md)| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **getAuthDevices** > List getAuthDevices() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); try { final result = api_instance.getAuthDevices(); print(result); } catch (e) { print('Exception when calling AuthenticationApi->getAuthDevices: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**List**](AuthDeviceResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **login** > LoginResponseDto login(loginCredentialDto) ### Example ```dart import 'package:openapi/api.dart'; final api_instance = AuthenticationApi(); final loginCredentialDto = LoginCredentialDto(); // LoginCredentialDto | try { final result = api_instance.login(loginCredentialDto); print(result); } catch (e) { print('Exception when calling AuthenticationApi->login: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loginCredentialDto** | [**LoginCredentialDto**](LoginCredentialDto.md)| | ### Return type [**LoginResponseDto**](LoginResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **logout** > LogoutResponseDto logout() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); try { final result = api_instance.logout(); print(result); } catch (e) { print('Exception when calling AuthenticationApi->logout: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**LogoutResponseDto**](LogoutResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **logoutAuthDevice** > logoutAuthDevice(id) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | try { api_instance.logoutAuthDevice(id); } catch (e) { print('Exception when calling AuthenticationApi->logoutAuthDevice: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| | ### Return type void (empty response body) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **logoutAuthDevices** > logoutAuthDevices() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); try { api_instance.logoutAuthDevices(); } catch (e) { print('Exception when calling AuthenticationApi->logoutAuthDevices: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type void (empty response body) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **signUpAdmin** > UserResponseDto signUpAdmin(signUpDto) ### Example ```dart import 'package:openapi/api.dart'; final api_instance = AuthenticationApi(); final signUpDto = SignUpDto(); // SignUpDto | try { final result = api_instance.signUpAdmin(signUpDto); print(result); } catch (e) { print('Exception when calling AuthenticationApi->signUpAdmin: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **signUpDto** | [**SignUpDto**](SignUpDto.md)| | ### Return type [**UserResponseDto**](UserResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **validateAccessToken** > ValidateAccessTokenResponseDto validateAccessToken() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = AuthenticationApi(); try { final result = api_instance.validateAccessToken(); print(result); } catch (e) { print('Exception when calling AuthenticationApi->validateAccessToken: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ValidateAccessTokenResponseDto**](ValidateAccessTokenResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)