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

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

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';

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

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

Documentation for API Endpoints

All URIs are relative to https://auth.forestvpn.com/v1

ClassMethodHTTP requestDescription
AuthApiintrospectPOST /introspect/Token introspection
AuthApiloginPOST /login/Login
AuthApiprofileGetGET /profile/Get authenticated user's profile
AuthApirefreshTokenPOST /token/Refresh access token
AuthApiregistrationSessionCreatePOST /registration/Create user registration session
AuthApiregistrationSessionValidatePUT /registration/{sessionId}/validate/Send email validation message
AuthApiregistrationSessionVerifyPUT /registration/{sessionId}/verify/Verify email address
AuthApisignInPOST /signin/Sign In
AuthApisignInResendPOST /signin/{sessionId}/resend/Resend OTP for Sign In
AuthApisignInVerifyPOST /signin/{sessionId}/verify/One time code verification
AuthApisignUpPOST /signup/Sign Up
AuthApisignUpResendPOST /signup/{sessionId}/resend/Resend OTP for Sign Up
AuthApisignUpVerifyPOST /signup/{sessionId}/verify/Sign Up verification

Documentation For Models

Documentation For Authorization

Bearer

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

Author

support@forestvpn.com

Libraries

forestvpn_auth_api.api