forestvpn_auth_api

Description:

forestvpn auth api

forestvpn_auth_api #
ForestVPN defeats content restrictions and censorship to deliver unlimited access to video, music, social media,
and more, from anywhere in the world.
This Dart package is automatically generated by the OpenAPI Generator project:

API version: 1.0
Build package: org.openapitools.codegen.languages.DartClientCodegen
For more information, please visit https://www.forestvpn.com/

Requirements #
Dart 2.0 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
forestvpn_auth_api:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
copied to clipboard
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
forestvpn_auth_api:
path: /path/to/forestvpn_auth_api
copied to clipboard
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:forestvpn_auth_api/api.dart';

// TODO Configure API key authorization: Bearer
//defaultApiClient.getAuthentication<ApiKeyAuth>('Bearer').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Bearer').apiKeyPrefix = 'Bearer';

final api_instance = AuthApi();
final request = IntrospectionRequest(); // IntrospectionRequest |

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

copied to clipboard
Documentation for API Endpoints #
All URIs are relative to https://auth.forestvpn.com/v1



Class
Method
HTTP request
Description




AuthApi
introspect
POST /introspect/
Token introspection


AuthApi
login
POST /login/
Login


AuthApi
profileGet
GET /profile/
Get authenticated user's profile


AuthApi
refreshToken
POST /token/
Refresh access token


AuthApi
registrationSessionCreate
POST /registration/
Create user registration session


AuthApi
registrationSessionValidate
PUT /registration/{sessionId}/validate/
Send email validation message


AuthApi
registrationSessionVerify
PUT /registration/{sessionId}/verify/
Verify email address


AuthApi
signIn
POST /signin/
Sign In


AuthApi
signInResend
POST /signin/{sessionId}/resend/
Resend OTP for Sign In


AuthApi
signInVerify
POST /signin/{sessionId}/verify/
One time code verification


AuthApi
signUp
POST /signup/
Sign Up


AuthApi
signUpResend
POST /signup/{sessionId}/resend/
Resend OTP for Sign Up


AuthApi
signUpVerify
POST /signup/{sessionId}/verify/
Sign Up verification



Documentation For Models #

Error
IntrospectionRequest
IntrospectionResponse
IntrospectionResponseExt
SignInRequest
SignInResponse
SignInVerifyRequest
SignUpRequest
SignUpResponse
SignUpVerifyRequest
TokenRequest
TokenResponse
UserLoginRequest
UserProfile
UserRegistrationRequest
UserRegistrationResponse
UserRegistrationVerifyRequest

Documentation For Authorization #
Bearer #

Type: API key
API key parameter name: Authorization
Location: HTTP header

Author #
[email protected]