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

Class Method HTTP request Description
AuthApi blockSkip POST /v2/auth/block/skip
AuthApi eventCreate POST /v2/auth/events
AuthApi identifierUpdate POST /v2/auth/identifier/update
AuthApi identifierVerifyFinish POST /v2/auth/identifier/verify/finish
AuthApi identifierVerifyStart POST /v2/auth/identifier/verify/start
AuthApi identifierVerifyStatus GET /v2/auth/identifier/verify/status
AuthApi loginInit POST /v2/auth/login/init
AuthApi passkeyAppendFinish POST /v2/auth/passkey/append/finish
AuthApi passkeyAppendStart POST /v2/auth/passkey/append/start
AuthApi passkeyLoginFinish POST /v2/auth/passkey/login/finish
AuthApi passkeyLoginStart POST /v2/auth/passkey/login/start
AuthApi passkeyMediationFinish POST /v2/auth/passkey/mediation/finish
AuthApi processComplete POST /v2/auth/process/complete
AuthApi processGet GET /v2/auth/process
AuthApi processInit POST /v2/auth/process/init
AuthApi processReset POST /v2/auth/process/reset
AuthApi signupInit POST /v2/auth/signup/init
AuthApi socialVerifyCallback GET /v2/auth/social/verify/callback
AuthApi socialVerifyFinish POST /v2/auth/social/verify/finish
AuthApi socialVerifyStart POST /v2/auth/social/verify/start
ConfigsApi getSessionConfig GET /v2/session-config
ConfigsApi getUserDetailsConfig GET /v2/user-details-config
CorbadoConnectApi connectAppendFinish POST /v2/connect/append/finish
CorbadoConnectApi connectAppendInit POST /v2/connect/append/init
CorbadoConnectApi connectAppendStart POST /v2/connect/append/start
CorbadoConnectApi connectEventCreate POST /v2/connect/events
CorbadoConnectApi connectLoginFinish POST /v2/connect/login/finish
CorbadoConnectApi connectLoginInit POST /v2/connect/login/init
CorbadoConnectApi connectLoginStart POST /v2/connect/login/start
CorbadoConnectApi connectManageDelete POST /v2/connect/manage/delete
CorbadoConnectApi connectManageInit POST /v2/connect/manage/init
CorbadoConnectApi connectManageList POST /v2/connect/manage/list
UsersApi currentUserDelete DELETE /v2/me
UsersApi currentUserGet GET /v2/me
UsersApi currentUserIdentifierCreate POST /v2/me/identifier
UsersApi currentUserIdentifierDelete DELETE /v2/me/identifier
UsersApi currentUserIdentifierUpdate PATCH /v2/me/identifier
UsersApi currentUserIdentifierVerifyFinish POST /v2/me/identifier/verify/finish
UsersApi currentUserIdentifierVerifyStart POST /v2/me/identifier/verify/start
UsersApi currentUserPasskeyAppendFinish POST /v2/me/passkeys/append/finish
UsersApi currentUserPasskeyAppendStart POST /v2/me/passkeys/append/start
UsersApi currentUserPasskeyDelete DELETE /v2/me/passkeys/{credentialID}
UsersApi currentUserPasskeyGet GET /v2/me/passkeys
UsersApi currentUserSessionLogout POST /v2/me/logout
UsersApi currentUserSessionRefresh POST /v2/me/refresh
UsersApi currentUserUpdate PATCH /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

Libraries

corbado_frontend_api_client