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
adminSignUp	POST /auth/admin-sign-up
changePassword	POST /auth/change-password
login	POST /auth/login
logout	POST /auth/logout
validateAccessToken	POST /auth/validateToken

adminSignUp

AdminSignupResponseDto adminSignUp(signUpDto)

Example

import 'package:openapi/api.dart';

final api_instance = AuthenticationApi();
final signUpDto = SignUpDto(); // SignUpDto | 

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

Parameters

Name	Type	Description	Notes
signUpDto	SignUpDto

Return type

AdminSignupResponseDto

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]

changePassword

UserResponseDto changePassword(changePasswordDto)

Example

import 'package:openapi/api.dart';
// 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

UserResponseDto

Authorization

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]

login

LoginResponseDto login(loginCredentialDto)

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()

Example

import 'package:openapi/api.dart';

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

No authorization required

HTTP request headers

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

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

validateAccessToken

ValidateAccessTokenResponseDto validateAccessToken()

Example

import 'package:openapi/api.dart';
// 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

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]