ory_kratos_client (EXPERIMENTAL)

This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more.

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

  • API version: v1.1.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

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

dependencies:
  ory_kratos_client: 1.1.0

Github

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

dependencies:
  ory_kratos_client:
    git:
      url: https://github.com/ory/sdk.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  ory_kratos_client:
    path: /path/to/ory_kratos_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_kratos_client/ory_kratos_client.dart';


final api = OryKratosClient().getCourierApi();
final String id = id_example; // String | MessageID is the ID of the message.

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
CourierApi getCourierMessage GET /admin/courier/messages/{id} Get a Message
CourierApi listCourierMessages GET /admin/courier/messages List Messages
FrontendApi createBrowserLoginFlow GET /self-service/login/browser Create Login Flow for Browsers
FrontendApi createBrowserLogoutFlow GET /self-service/logout/browser Create a Logout URL for Browsers
FrontendApi createBrowserRecoveryFlow GET /self-service/recovery/browser Create Recovery Flow for Browsers
FrontendApi createBrowserRegistrationFlow GET /self-service/registration/browser Create Registration Flow for Browsers
FrontendApi createBrowserSettingsFlow GET /self-service/settings/browser Create Settings Flow for Browsers
FrontendApi createBrowserVerificationFlow GET /self-service/verification/browser Create Verification Flow for Browser Clients
FrontendApi createNativeLoginFlow GET /self-service/login/api Create Login Flow for Native Apps
FrontendApi createNativeRecoveryFlow GET /self-service/recovery/api Create Recovery Flow for Native Apps
FrontendApi createNativeRegistrationFlow GET /self-service/registration/api Create Registration Flow for Native Apps
FrontendApi createNativeSettingsFlow GET /self-service/settings/api Create Settings Flow for Native Apps
FrontendApi createNativeVerificationFlow GET /self-service/verification/api Create Verification Flow for Native Apps
FrontendApi disableMyOtherSessions DELETE /sessions Disable my other sessions
FrontendApi disableMySession DELETE /sessions/{id} Disable one of my sessions
FrontendApi exchangeSessionToken GET /sessions/token-exchange Exchange Session Token
FrontendApi getFlowError GET /self-service/errors Get User-Flow Errors
FrontendApi getLoginFlow GET /self-service/login/flows Get Login Flow
FrontendApi getRecoveryFlow GET /self-service/recovery/flows Get Recovery Flow
FrontendApi getRegistrationFlow GET /self-service/registration/flows Get Registration Flow
FrontendApi getSettingsFlow GET /self-service/settings/flows Get Settings Flow
FrontendApi getVerificationFlow GET /self-service/verification/flows Get Verification Flow
FrontendApi getWebAuthnJavaScript GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
FrontendApi listMySessions GET /sessions Get My Active Sessions
FrontendApi performNativeLogout DELETE /self-service/logout/api Perform Logout for Native Apps
FrontendApi toSession GET /sessions/whoami Check Who the Current HTTP Session Belongs To
FrontendApi updateLoginFlow POST /self-service/login Submit a Login Flow
FrontendApi updateLogoutFlow GET /self-service/logout Update Logout Flow
FrontendApi updateRecoveryFlow POST /self-service/recovery Update Recovery Flow
FrontendApi updateRegistrationFlow POST /self-service/registration Update Registration Flow
FrontendApi updateSettingsFlow POST /self-service/settings Complete Settings Flow
FrontendApi updateVerificationFlow POST /self-service/verification Complete Verification Flow
IdentityApi batchPatchIdentities PATCH /admin/identities Create and deletes multiple identities
IdentityApi createIdentity POST /admin/identities Create an Identity
IdentityApi createRecoveryCodeForIdentity POST /admin/recovery/code Create a Recovery Code
IdentityApi createRecoveryLinkForIdentity POST /admin/recovery/link Create a Recovery Link
IdentityApi deleteIdentity DELETE /admin/identities/{id} Delete an Identity
IdentityApi deleteIdentityCredentials DELETE /admin/identities/{id}/credentials/{type} Delete a credential for a specific identity
IdentityApi deleteIdentitySessions DELETE /admin/identities/{id}/sessions Delete & Invalidate an Identity's Sessions
IdentityApi disableSession DELETE /admin/sessions/{id} Deactivate a Session
IdentityApi extendSession PATCH /admin/sessions/{id}/extend Extend a Session
IdentityApi getIdentity GET /admin/identities/{id} Get an Identity
IdentityApi getIdentitySchema GET /schemas/{id} Get Identity JSON Schema
IdentityApi getSession GET /admin/sessions/{id} Get Session
IdentityApi listIdentities GET /admin/identities List Identities
IdentityApi listIdentitySchemas GET /schemas Get all Identity Schemas
IdentityApi listIdentitySessions GET /admin/identities/{id}/sessions List an Identity's Sessions
IdentityApi listSessions GET /admin/sessions List All Sessions
IdentityApi patchIdentity PATCH /admin/identities/{id} Patch an Identity
IdentityApi updateIdentity PUT /admin/identities/{id} Update an Identity
MetadataApi getVersion GET /version Return Running Software Version.
MetadataApi isAlive GET /health/alive Check HTTP Server Status
MetadataApi isReady GET /health/ready Check HTTP Server and Database Status

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oryAccessToken

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

Author

office@ory.sh

Libraries

ory_kratos_client