immich/mobile/openapi/doc/OAuthApi.md

openapi.api.OAuthApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
finishOAuth	POST /oauth/callback
generateOAuthConfig	POST /oauth/config
linkOAuthAccount	POST /oauth/link
redirectOAuthToMobile	GET /oauth/mobile-redirect
startOAuth	POST /oauth/authorize
unlinkOAuthAccount	POST /oauth/unlink

finishOAuth

LoginResponseDto finishOAuth(oAuthCallbackDto)

Example

import 'package:openapi/api.dart';

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

try {
    final result = api_instance.finishOAuth(oAuthCallbackDto);
    print(result);
} catch (e) {
    print('Exception when calling OAuthApi->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]

generateOAuthConfig

OAuthConfigResponseDto generateOAuthConfig(oAuthConfigDto)

@deprecated use feature flags and /oauth/authorize

Example

import 'package:openapi/api.dart';

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

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

Parameters

Name	Type	Description	Notes
oAuthConfigDto	OAuthConfigDto

Return type

OAuthConfigResponseDto

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]

linkOAuthAccount

UserResponseDto linkOAuthAccount(oAuthCallbackDto)

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 = OAuthApi();
final oAuthCallbackDto = OAuthCallbackDto(); // OAuthCallbackDto | 

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

Parameters

Name	Type	Description	Notes
oAuthCallbackDto	OAuthCallbackDto

Return type

UserResponseDto

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]

redirectOAuthToMobile

redirectOAuthToMobile()

Example

import 'package:openapi/api.dart';

final api_instance = OAuthApi();

try {
    api_instance.redirectOAuthToMobile();
} catch (e) {
    print('Exception when calling OAuthApi->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]

startOAuth

OAuthAuthorizeResponseDto startOAuth(oAuthConfigDto)

Example

import 'package:openapi/api.dart';

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

try {
    final result = api_instance.startOAuth(oAuthConfigDto);
    print(result);
} catch (e) {
    print('Exception when calling OAuthApi->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

UserResponseDto unlinkOAuthAccount()

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 = OAuthApi();

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

Parameters

This endpoint does not need any parameter.

Return type

UserResponseDto

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]