ory_kratos_client 1.1.0

SDKdartflutter
Platformandroidioswindowslinuxmacosweb

OpenAPI API client for Ory Kratos, Ory's central identity management solution with hardened authentication, MFA, FIDO2, TOTP, WebAuthn, SSO, profile management, and more.

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

ClassMethodHTTP requestDescription
CourierApigetCourierMessageGET /admin/courier/messages/{id}Get a Message
CourierApilistCourierMessagesGET /admin/courier/messagesList Messages
FrontendApicreateBrowserLoginFlowGET /self-service/login/browserCreate Login Flow for Browsers
FrontendApicreateBrowserLogoutFlowGET /self-service/logout/browserCreate a Logout URL for Browsers
FrontendApicreateBrowserRecoveryFlowGET /self-service/recovery/browserCreate Recovery Flow for Browsers
FrontendApicreateBrowserRegistrationFlowGET /self-service/registration/browserCreate Registration Flow for Browsers
FrontendApicreateBrowserSettingsFlowGET /self-service/settings/browserCreate Settings Flow for Browsers
FrontendApicreateBrowserVerificationFlowGET /self-service/verification/browserCreate Verification Flow for Browser Clients
FrontendApicreateNativeLoginFlowGET /self-service/login/apiCreate Login Flow for Native Apps
FrontendApicreateNativeRecoveryFlowGET /self-service/recovery/apiCreate Recovery Flow for Native Apps
FrontendApicreateNativeRegistrationFlowGET /self-service/registration/apiCreate Registration Flow for Native Apps
FrontendApicreateNativeSettingsFlowGET /self-service/settings/apiCreate Settings Flow for Native Apps
FrontendApicreateNativeVerificationFlowGET /self-service/verification/apiCreate Verification Flow for Native Apps
FrontendApidisableMyOtherSessionsDELETE /sessionsDisable my other sessions
FrontendApidisableMySessionDELETE /sessions/{id}Disable one of my sessions
FrontendApiexchangeSessionTokenGET /sessions/token-exchangeExchange Session Token
FrontendApigetFlowErrorGET /self-service/errorsGet User-Flow Errors
FrontendApigetLoginFlowGET /self-service/login/flowsGet Login Flow
FrontendApigetRecoveryFlowGET /self-service/recovery/flowsGet Recovery Flow
FrontendApigetRegistrationFlowGET /self-service/registration/flowsGet Registration Flow
FrontendApigetSettingsFlowGET /self-service/settings/flowsGet Settings Flow
FrontendApigetVerificationFlowGET /self-service/verification/flowsGet Verification Flow
FrontendApigetWebAuthnJavaScriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
FrontendApilistMySessionsGET /sessionsGet My Active Sessions
FrontendApiperformNativeLogoutDELETE /self-service/logout/apiPerform Logout for Native Apps
FrontendApitoSessionGET /sessions/whoamiCheck Who the Current HTTP Session Belongs To
FrontendApiupdateLoginFlowPOST /self-service/loginSubmit a Login Flow
FrontendApiupdateLogoutFlowGET /self-service/logoutUpdate Logout Flow
FrontendApiupdateRecoveryFlowPOST /self-service/recoveryUpdate Recovery Flow
FrontendApiupdateRegistrationFlowPOST /self-service/registrationUpdate Registration Flow
FrontendApiupdateSettingsFlowPOST /self-service/settingsComplete Settings Flow
FrontendApiupdateVerificationFlowPOST /self-service/verificationComplete Verification Flow
IdentityApibatchPatchIdentitiesPATCH /admin/identitiesCreate and deletes multiple identities
IdentityApicreateIdentityPOST /admin/identitiesCreate an Identity
IdentityApicreateRecoveryCodeForIdentityPOST /admin/recovery/codeCreate a Recovery Code
IdentityApicreateRecoveryLinkForIdentityPOST /admin/recovery/linkCreate a Recovery Link
IdentityApideleteIdentityDELETE /admin/identities/{id}Delete an Identity
IdentityApideleteIdentityCredentialsDELETE /admin/identities/{id}/credentials/{type}Delete a credential for a specific identity
IdentityApideleteIdentitySessionsDELETE /admin/identities/{id}/sessionsDelete & Invalidate an Identity's Sessions
IdentityApidisableSessionDELETE /admin/sessions/{id}Deactivate a Session
IdentityApiextendSessionPATCH /admin/sessions/{id}/extendExtend a Session
IdentityApigetIdentityGET /admin/identities/{id}Get an Identity
IdentityApigetIdentitySchemaGET /schemas/{id}Get Identity JSON Schema
IdentityApigetSessionGET /admin/sessions/{id}Get Session
IdentityApilistIdentitiesGET /admin/identitiesList Identities
IdentityApilistIdentitySchemasGET /schemasGet all Identity Schemas
IdentityApilistIdentitySessionsGET /admin/identities/{id}/sessionsList an Identity's Sessions
IdentityApilistSessionsGET /admin/sessionsList All Sessions
IdentityApipatchIdentityPATCH /admin/identities/{id}Patch an Identity
IdentityApiupdateIdentityPUT /admin/identities/{id}Update an Identity
MetadataApigetVersionGET /versionReturn Running Software Version.
MetadataApiisAliveGET /health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /health/readyCheck 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