corbado_frontend_api_client 2.2.0
SDKdartflutter
Platformandroidioswindowslinuxmacos
Client for the Corbado Frontend API
corbado_frontend_api_client (EXPERIMENTAL)
Overview of all Corbado Frontend API calls to implement passwordless authentication.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 2.0.4
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen For more information, please visit https://www.corbado.com
Requirements
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage
pub.dev
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
corbado_frontend_api_client: 2.0.0
Github
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
corbado_frontend_api_client:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
Local development
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
corbado_frontend_api_client:
path: /path/to/corbado_frontend_api_client
Getting Started
Please follow the installation procedure and then run the following:
import 'package:corbado_frontend_api_client/corbado_frontend_api_client.dart';
final api = CorbadoFrontendApiClient().getAuthApi();
try {
final response = await api.blockSkip();
print(response);
} catch on DioException (e) {
print("Exception when calling AuthApi->blockSkip: $e\n");
}
Documentation for API Endpoints
All URIs are relative to https://<project ID>.frontendapi.corbado.io
Documentation For Models
- AuthType
- BlockBody
- BlockBodyData
- BlockType
- ClientCapabilities
- ClientInformation
- ConnectAppendFinishReq
- ConnectAppendFinishRsp
- ConnectAppendInitReq
- ConnectAppendInitRsp
- ConnectAppendStartReq
- ConnectAppendStartRsp
- ConnectEventCreateReq
- ConnectLoginFinishReq
- ConnectLoginFinishRsp
- ConnectLoginInitReq
- ConnectLoginInitRsp
- ConnectLoginStartReq
- ConnectLoginStartRsp
- ConnectManageDeleteReq
- ConnectManageDeleteRsp
- ConnectManageInitReq
- ConnectManageInitRsp
- ConnectManageListReq
- ConnectManageListRsp
- ContinueOnOtherDevice
- EventCreateReq
- FullNameWithError
- GeneralBlockCompleted
- GeneralBlockLoginInit
- GeneralBlockPasskeyAppend
- GeneralBlockPasskeyAppended
- GeneralBlockPasskeyVerify
- GeneralBlockPostSignupEmailVerify
- GeneralBlockSignupInit
- GeneralBlockVerifyIdentifier
- GeneralBlockVerifyIdentifierAlternativeVerificationMethodsInner
- GenericRsp
- Identifier
- IdentifierUpdateReq
- IdentifierVerifyFinishReq
- IdentifierVerifyStartReq
- JavaScriptHighEntropy
- LoginIdentifier
- LoginIdentifierConfig
- LoginIdentifierType
- LoginIdentifierWithError
- LoginInitReq
- MeIdentifierCreateReq
- MeIdentifierDeleteReq
- MeIdentifierUpdateReq
- MeIdentifierVerifyFinishReq
- MeIdentifierVerifyStartReq
- MePasskeyDeleteRsp
- MePasskeyRsp
- MePasskeysAppendFinishReq
- MePasskeysAppendStartReq
- MePasskeysAppendStartRsp
- MeRefreshRsp
- MeRsp
- MeUpdateReq
- Paging
- Passkey
- PasskeyAppendFinishReq
- PasskeyAppendStartReq
- PasskeyEventType
- PasskeyIconSet
- PasskeyLoginFinishReq
- PasskeyLoginStartReq
- PasskeyMediationFinishReq
- PasskeyOperation
- ProcessCommon
- ProcessInitReq
- ProcessInitRsp
- ProcessResponse
- ProcessStaticInfo
- RequestData
- RequestError
- SessionConfigRsp
- ShortSessionCookieConfig
- SignupInitReq
- SocialAccount
- SocialData
- SocialProviderType
- SocialVerifyStartReq
- UserDetailsConfigRsp
- VerificationMethod
Documentation For Authorization
Authentication schemes defined for the API:
basicAuth
- Type: HTTP basic authentication
bearerAuth
- Type: HTTP Bearer Token authentication (JWT)
projectID
- Type: API key
- API key parameter name: X-Corbado-ProjectID
- Location: HTTP header