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

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

ClassMethodHTTP requestDescription
AuthApiblockSkipPOST /v2/auth/block/skip
AuthApieventCreatePOST /v2/auth/events
AuthApiidentifierUpdatePOST /v2/auth/identifier/update
AuthApiidentifierVerifyFinishPOST /v2/auth/identifier/verify/finish
AuthApiidentifierVerifyStartPOST /v2/auth/identifier/verify/start
AuthApiidentifierVerifyStatusGET /v2/auth/identifier/verify/status
AuthApiloginInitPOST /v2/auth/login/init
AuthApipasskeyAppendFinishPOST /v2/auth/passkey/append/finish
AuthApipasskeyAppendStartPOST /v2/auth/passkey/append/start
AuthApipasskeyLoginFinishPOST /v2/auth/passkey/login/finish
AuthApipasskeyLoginStartPOST /v2/auth/passkey/login/start
AuthApipasskeyMediationFinishPOST /v2/auth/passkey/mediation/finish
AuthApiprocessCompletePOST /v2/auth/process/complete
AuthApiprocessGetGET /v2/auth/process
AuthApiprocessInitPOST /v2/auth/process/init
AuthApiprocessResetPOST /v2/auth/process/reset
AuthApisignupInitPOST /v2/auth/signup/init
AuthApisocialVerifyCallbackGET /v2/auth/social/verify/callback
AuthApisocialVerifyFinishPOST /v2/auth/social/verify/finish
AuthApisocialVerifyStartPOST /v2/auth/social/verify/start
ConfigsApigetSessionConfigGET /v2/session-config
ConfigsApigetUserDetailsConfigGET /v2/user-details-config
CorbadoConnectApiconnectAppendFinishPOST /v2/connect/append/finish
CorbadoConnectApiconnectAppendInitPOST /v2/connect/append/init
CorbadoConnectApiconnectAppendStartPOST /v2/connect/append/start
CorbadoConnectApiconnectEventCreatePOST /v2/connect/events
CorbadoConnectApiconnectLoginFinishPOST /v2/connect/login/finish
CorbadoConnectApiconnectLoginInitPOST /v2/connect/login/init
CorbadoConnectApiconnectLoginStartPOST /v2/connect/login/start
CorbadoConnectApiconnectManageDeletePOST /v2/connect/manage/delete
CorbadoConnectApiconnectManageInitPOST /v2/connect/manage/init
CorbadoConnectApiconnectManageListPOST /v2/connect/manage/list
UsersApicurrentUserDeleteDELETE /v2/me
UsersApicurrentUserGetGET /v2/me
UsersApicurrentUserIdentifierCreatePOST /v2/me/identifier
UsersApicurrentUserIdentifierDeleteDELETE /v2/me/identifier
UsersApicurrentUserIdentifierUpdatePATCH /v2/me/identifier
UsersApicurrentUserIdentifierVerifyFinishPOST /v2/me/identifier/verify/finish
UsersApicurrentUserIdentifierVerifyStartPOST /v2/me/identifier/verify/start
UsersApicurrentUserPasskeyAppendFinishPOST /v2/me/passkeys/append/finish
UsersApicurrentUserPasskeyAppendStartPOST /v2/me/passkeys/append/start
UsersApicurrentUserPasskeyDeleteDELETE /v2/me/passkeys/{credentialID}
UsersApicurrentUserPasskeyGetGET /v2/me/passkeys
UsersApicurrentUserSessionLogoutPOST /v2/me/logout
UsersApicurrentUserSessionRefreshPOST /v2/me/refresh
UsersApicurrentUserUpdatePATCH /v2/me

Documentation For Models

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

Author

support@corbado.com