immich/mobile/openapi/doc/AuthenticationApi.md

openapi.api.AuthenticationApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
changePassword	POST /auth/change-password	Change password
changePinCode	PUT /auth/pin-code	Change pin code
finishOAuth	POST /oauth/callback	Finish OAuth
getAuthStatus	GET /auth/status	Retrieve auth status
linkOAuthAccount	POST /oauth/link	Link OAuth account
lockAuthSession	POST /auth/session/lock	Lock auth session
login	POST /auth/login	Login
logout	POST /auth/logout	Logout
logoutOAuth	POST /oauth/backchannel-logout	Backchannel OAuth logout
redirectOAuthToMobile	GET /oauth/mobile-redirect	Redirect OAuth to mobile
resetPinCode	DELETE /auth/pin-code	Reset pin code
setupPinCode	POST /auth/pin-code	Setup pin code
signUpAdmin	POST /auth/admin-sign-up	Register admin
startOAuth	POST /oauth/authorize	Start OAuth
unlinkOAuthAccount	POST /oauth/unlink	Unlink OAuth account
unlockAuthSession	POST /auth/session/unlock	Unlock auth session
validateAccessToken	POST /auth/validateToken	Validate access token

changePassword

UserAdminResponseDto changePassword(changePasswordDto)

Change password

Change the password of the current user.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Return type

UserAdminResponseDto

Authorization

cookie, api_key, bearer

HTTP request headers

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

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

changePinCode

changePinCode(pinCodeChangeDto)

Change pin code

Change the pin code for the current user.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();
final pinCodeChangeDto = PinCodeChangeDto(); // PinCodeChangeDto | 

try {
    api_instance.changePinCode(pinCodeChangeDto);
} catch (e) {
    print('Exception when calling AuthenticationApi->changePinCode: $e\n');
}

Parameters

Name	Type	Description	Notes
pinCodeChangeDto	PinCodeChangeDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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

finishOAuth

LoginResponseDto finishOAuth(oAuthCallbackDto)

Finish OAuth

Complete the OAuth authorization process by exchanging the authorization code for a session token.

Example

import 'package:openapi/api.dart';

final api_instance = AuthenticationApi();
final oAuthCallbackDto = OAuthCallbackDto(); // OAuthCallbackDto | 

try {
    final result = api_instance.finishOAuth(oAuthCallbackDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->finishOAuth: $e\n');
}

Parameters

Name	Type	Description	Notes
oAuthCallbackDto	OAuthCallbackDto

Return type

LoginResponseDto

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]

getAuthStatus

AuthStatusResponseDto getAuthStatus()

Retrieve auth status

Get information about the current session, including whether the user has a password, and if the session can access locked assets.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();

try {
    final result = api_instance.getAuthStatus();
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->getAuthStatus: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

AuthStatusResponseDto

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

linkOAuthAccount

UserAdminResponseDto linkOAuthAccount(oAuthCallbackDto)

Link OAuth account

Link an OAuth account to the authenticated user.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();
final oAuthCallbackDto = OAuthCallbackDto(); // OAuthCallbackDto | 

try {
    final result = api_instance.linkOAuthAccount(oAuthCallbackDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->linkOAuthAccount: $e\n');
}

Parameters

Name	Type	Description	Notes
oAuthCallbackDto	OAuthCallbackDto

Return type

UserAdminResponseDto

Authorization

cookie, api_key, bearer

HTTP request headers

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

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

lockAuthSession

lockAuthSession()

Lock auth session

Remove elevated access to locked assets from the current session.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();

try {
    api_instance.lockAuthSession();
} catch (e) {
    print('Exception when calling AuthenticationApi->lockAuthSession: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

login

LoginResponseDto login(loginCredentialDto)

Login

Login with username and password and receive a session token.

Example

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

Return type

LoginResponseDto

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]

logout

LogoutResponseDto logout()

Logout

Logout the current user and invalidate the session token.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

logoutOAuth

logoutOAuth(logoutToken)

Backchannel OAuth logout

Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present.

Example

import 'package:openapi/api.dart';

final api_instance = AuthenticationApi();
final logoutToken = logoutToken_example; // String | OAuth logout token

try {
    api_instance.logoutOAuth(logoutToken);
} catch (e) {
    print('Exception when calling AuthenticationApi->logoutOAuth: $e\n');
}

Parameters

Name	Type	Description	Notes
logoutToken	String	OAuth logout token

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

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

redirectOAuthToMobile

redirectOAuthToMobile()

Redirect OAuth to mobile

Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting.

Example

import 'package:openapi/api.dart';

final api_instance = AuthenticationApi();

try {
    api_instance.redirectOAuthToMobile();
} catch (e) {
    print('Exception when calling AuthenticationApi->redirectOAuthToMobile: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

resetPinCode

resetPinCode(pinCodeResetDto)

Reset pin code

Reset the pin code for the current user by providing the account password

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();
final pinCodeResetDto = PinCodeResetDto(); // PinCodeResetDto | 

try {
    api_instance.resetPinCode(pinCodeResetDto);
} catch (e) {
    print('Exception when calling AuthenticationApi->resetPinCode: $e\n');
}

Parameters

Name	Type	Description	Notes
pinCodeResetDto	PinCodeResetDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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

setupPinCode

setupPinCode(pinCodeSetupDto)

Setup pin code

Setup a new pin code for the current user.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();
final pinCodeSetupDto = PinCodeSetupDto(); // PinCodeSetupDto | 

try {
    api_instance.setupPinCode(pinCodeSetupDto);
} catch (e) {
    print('Exception when calling AuthenticationApi->setupPinCode: $e\n');
}

Parameters

Name	Type	Description	Notes
pinCodeSetupDto	PinCodeSetupDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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

signUpAdmin

UserAdminResponseDto signUpAdmin(signUpDto)

Register admin

Create the first admin user in the system.

Example

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

Return type

UserAdminResponseDto

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]

startOAuth

OAuthAuthorizeResponseDto startOAuth(oAuthConfigDto)

Start OAuth

Initiate the OAuth authorization process.

Example

import 'package:openapi/api.dart';

final api_instance = AuthenticationApi();
final oAuthConfigDto = OAuthConfigDto(); // OAuthConfigDto | 

try {
    final result = api_instance.startOAuth(oAuthConfigDto);
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->startOAuth: $e\n');
}

Parameters

Name	Type	Description	Notes
oAuthConfigDto	OAuthConfigDto

Return type

OAuthAuthorizeResponseDto

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]

unlinkOAuthAccount

UserAdminResponseDto unlinkOAuthAccount()

Unlink OAuth account

Unlink the OAuth account from the authenticated user.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();

try {
    final result = api_instance.unlinkOAuthAccount();
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->unlinkOAuthAccount: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

UserAdminResponseDto

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

unlockAuthSession

unlockAuthSession(sessionUnlockDto)

Unlock auth session

Temporarily grant the session elevated access to locked assets by providing the correct PIN code.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AuthenticationApi();
final sessionUnlockDto = SessionUnlockDto(); // SessionUnlockDto | 

try {
    api_instance.unlockAuthSession(sessionUnlockDto);
} catch (e) {
    print('Exception when calling AuthenticationApi->unlockAuthSession: $e\n');
}

Parameters

Name	Type	Description	Notes
sessionUnlockDto	SessionUnlockDto

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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

validateAccessToken

ValidateAccessTokenResponseDto validateAccessToken()

Validate access token

Validate the current authorization method is still valid.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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