kratos_api_dart 1.0.0 icon indicating copy to clipboard operation
kratos_api_dart: ^1.0.0 copied to clipboard

Ory Kratos Dart API client

kratos_api_dart (EXPERIMENTAL) #

Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen

Requirements #

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  kratos_api_dart: 1.0.0

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  kratos_api_dart:
    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:
  kratos_api_dart:
    path: /path/to/kratos_api_dart

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:kratos_api_dart/kratos_api_dart.dart';


final api = KratosApiDart().getMetadataApi();

try {
    final response = await api.getVersion();
    print(response);
} catch on DioError (e) {
    print("Exception when calling MetadataApi->getVersion: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
MetadataApigetVersionGET /versionReturn Running Software Version.
MetadataApiisAliveGET /health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /health/readyCheck HTTP Server and Database Status
V0alpha2ApiadminCreateIdentityPOST /identitiesCreate an Identity
V0alpha2ApiadminCreateSelfServiceRecoveryLinkPOST /recovery/linkCreate a Recovery Link
V0alpha2ApiadminDeleteIdentityDELETE /identities/{id}Delete an Identity
V0alpha2ApiadminDeleteIdentitySessionsDELETE /identities/{id}/sessionsCalling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2ApiadminGetIdentityGET /identities/{id}Get an Identity
V0alpha2ApiadminListIdentitiesGET /identitiesList Identities
V0alpha2ApiadminUpdateIdentityPUT /identities/{id}Update an Identity
V0alpha2ApicreateSelfServiceLogoutFlowUrlForBrowsersGET /self-service/logout/browserCreate a Logout URL for Browsers
V0alpha2ApigetJsonSchemaGET /schemas/{id}
V0alpha2ApigetSelfServiceErrorGET /self-service/errorsGet Self-Service Errors
V0alpha2ApigetSelfServiceLoginFlowGET /self-service/login/flowsGet Login Flow
V0alpha2ApigetSelfServiceRecoveryFlowGET /self-service/recovery/flowsGet Recovery Flow
V0alpha2ApigetSelfServiceRegistrationFlowGET /self-service/registration/flowsGet Registration Flow
V0alpha2ApigetSelfServiceSettingsFlowGET /self-service/settings/flowsGet Settings Flow
V0alpha2ApigetSelfServiceVerificationFlowGET /self-service/verification/flowsGet Verification Flow
V0alpha2ApigetWebAuthnJavaScriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
V0alpha2ApiinitializeSelfServiceLoginFlowForBrowsersGET /self-service/login/browserInitialize Login Flow for Browsers
V0alpha2ApiinitializeSelfServiceLoginFlowWithoutBrowserGET /self-service/login/apiInitialize Login Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRecoveryFlowForBrowsersGET /self-service/recovery/browserInitialize Recovery Flow for Browsers
V0alpha2ApiinitializeSelfServiceRecoveryFlowWithoutBrowserGET /self-service/recovery/apiInitialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRegistrationFlowForBrowsersGET /self-service/registration/browserInitialize Registration Flow for Browsers
V0alpha2ApiinitializeSelfServiceRegistrationFlowWithoutBrowserGET /self-service/registration/apiInitialize Registration Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceSettingsFlowForBrowsersGET /self-service/settings/browserInitialize Settings Flow for Browsers
V0alpha2ApiinitializeSelfServiceSettingsFlowWithoutBrowserGET /self-service/settings/apiInitialize Settings Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceVerificationFlowForBrowsersGET /self-service/verification/browserInitialize Verification Flow for Browser Clients
V0alpha2ApiinitializeSelfServiceVerificationFlowWithoutBrowserGET /self-service/verification/apiInitialize Verification Flow for APIs, Services, Apps, ...
V0alpha2ApilistIdentitySchemasGET /schemas
V0alpha2ApisubmitSelfServiceLoginFlowPOST /self-service/loginSubmit a Login Flow
V0alpha2ApisubmitSelfServiceLogoutFlowGET /self-service/logoutComplete Self-Service Logout
V0alpha2ApisubmitSelfServiceLogoutFlowWithoutBrowserDELETE /self-service/logout/apiPerform Logout for APIs, Services, Apps, ...
V0alpha2ApisubmitSelfServiceRecoveryFlowPOST /self-service/recoveryComplete Recovery Flow
V0alpha2ApisubmitSelfServiceRegistrationFlowPOST /self-service/registrationSubmit a Registration Flow
V0alpha2ApisubmitSelfServiceSettingsFlowPOST /self-service/settingsComplete Settings Flow
V0alpha2ApisubmitSelfServiceVerificationFlowPOST /self-service/verificationComplete Verification Flow
V0alpha2ApitoSessionGET /sessions/whoamiCheck Who the Current HTTP Session Belongs To

Documentation For Models #

Documentation For Authorization #

oryAccessToken #

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

Author #

hi@ory.sh