ory_kratos_client 0.5.5-alpha.4

OpenAPI API client

ory_kratos_client

Welcome to the ORY Kratos HTTP API documentation!

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

• API version: v0.5.5-alpha.4
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  ory_kratos_client:
    git: https://github.com/ory/sdk.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

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

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_kratos_client/api.dart';


final api_instance = AdminApi();
final body = CreateIdentity(); // CreateIdentity | 

try {
    final result = api_instance.createIdentity(body);
    print(result);
} catch (e) {
    print('Exception when calling AdminApi->createIdentity: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdminApi	createIdentity	POST /identities	Create an Identity
AdminApi	createRecoveryLink	POST /recovery/link	Create a Recovery Link
AdminApi	deleteIdentity	DELETE /identities/{id}	Delete an Identity
AdminApi	getIdentity	GET /identities/{id}	Get an Identity
AdminApi	getSchema	GET /schemas/{id}
AdminApi	getSelfServiceError	GET /self-service/errors	Get User-Facing Self-Service Errors
AdminApi	getSelfServiceLoginFlow	GET /self-service/login/flows	Get Login Flow
AdminApi	getSelfServiceRecoveryFlow	GET /self-service/recovery/flows	Get information about a recovery flow
AdminApi	getSelfServiceRegistrationFlow	GET /self-service/registration/flows	Get Registration Flow
AdminApi	getSelfServiceSettingsFlow	GET /self-service/settings/flows	Get Settings Flow
AdminApi	getSelfServiceVerificationFlow	GET /self-service/verification/flows	Get Verification Flow
AdminApi	listIdentities	GET /identities	List Identities
AdminApi	prometheus	GET /metrics/prometheus	Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
AdminApi	updateIdentity	PUT /identities/{id}	Update an Identity
HealthApi	isInstanceAlive	GET /health/alive	Check alive status
HealthApi	isInstanceReady	GET /health/ready	Check readiness status
PublicApi	completeSelfServiceBrowserSettingsOIDCSettingsFlow	POST /self-service/browser/flows/registration/strategies/oidc/settings/connections	Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
PublicApi	completeSelfServiceLoginFlowWithPasswordMethod	POST /self-service/login/methods/password	Complete Login Flow with Username/Email Password Method
PublicApi	completeSelfServiceRecoveryFlowWithLinkMethod	POST /self-service/recovery/methods/link	Complete Recovery Flow with Link Method
PublicApi	completeSelfServiceRegistrationFlowWithPasswordMethod	POST /self-service/registration/methods/password	Complete Registration Flow with Username/Email Password Method
PublicApi	completeSelfServiceSettingsFlowWithPasswordMethod	POST /self-service/settings/methods/password	Complete Settings Flow with Username/Email Password Method
PublicApi	completeSelfServiceSettingsFlowWithProfileMethod	POST /self-service/settings/methods/profile	Complete Settings Flow with Profile Method
PublicApi	completeSelfServiceVerificationFlowWithLinkMethod	POST /self-service/verification/methods/link	Complete Verification Flow with Link Method
PublicApi	getSchema	GET /schemas/{id}
PublicApi	getSelfServiceError	GET /self-service/errors	Get User-Facing Self-Service Errors
PublicApi	getSelfServiceLoginFlow	GET /self-service/login/flows	Get Login Flow
PublicApi	getSelfServiceRecoveryFlow	GET /self-service/recovery/flows	Get information about a recovery flow
PublicApi	getSelfServiceRegistrationFlow	GET /self-service/registration/flows	Get Registration Flow
PublicApi	getSelfServiceSettingsFlow	GET /self-service/settings/flows	Get Settings Flow
PublicApi	getSelfServiceVerificationFlow	GET /self-service/verification/flows	Get Verification Flow
PublicApi	initializeSelfServiceBrowserLogoutFlow	GET /self-service/browser/flows/logout	Initialize Browser-Based Logout User Flow
PublicApi	initializeSelfServiceLoginViaAPIFlow	GET /self-service/login/api	Initialize Login Flow for API clients
PublicApi	initializeSelfServiceLoginViaBrowserFlow	GET /self-service/login/browser	Initialize Login Flow for browsers
PublicApi	initializeSelfServiceRecoveryViaAPIFlow	GET /self-service/recovery/api	Initialize Recovery Flow for API Clients
PublicApi	initializeSelfServiceRecoveryViaBrowserFlow	GET /self-service/recovery/browser	Initialize Recovery Flow for Browser Clients
PublicApi	initializeSelfServiceRegistrationViaAPIFlow	GET /self-service/registration/api	Initialize Registration Flow for API clients
PublicApi	initializeSelfServiceRegistrationViaBrowserFlow	GET /self-service/registration/browser	Initialize Registration Flow for browsers
PublicApi	initializeSelfServiceSettingsViaAPIFlow	GET /self-service/settings/api	Initialize Settings Flow for API Clients
PublicApi	initializeSelfServiceSettingsViaBrowserFlow	GET /self-service/settings/browser	Initialize Settings Flow for Browsers
PublicApi	initializeSelfServiceVerificationViaAPIFlow	GET /self-service/verification/api	Initialize Verification Flow for API Clients
PublicApi	initializeSelfServiceVerificationViaBrowserFlow	GET /self-service/verification/browser	Initialize Verification Flow for Browser Clients
PublicApi	revokeSession	DELETE /sessions	Revoke and Invalidate a Session
PublicApi	whoami	GET /sessions/whoami	Check Who the Current HTTP Session Belongs To
VersionApi	getVersion	GET /version	Get service version

Documentation For Models

• CompleteSelfServiceLoginFlowWithPasswordMethod
• CompleteSelfServiceRecoveryFlowWithLinkMethod
• CompleteSelfServiceSettingsFlowWithPasswordMethod
• CompleteSelfServiceVerificationFlowWithLinkMethod
• CreateIdentity
• CreateRecoveryLink
• ErrorContainer
• FormField
• GenericError
• GenericErrorPayload
• HealthNotReadyStatus
• HealthStatus
• Identity
• LoginFlow
• LoginFlowMethod
• LoginFlowMethodConfig
• LoginViaApiResponse
• Message
• RecoveryAddress
• RecoveryFlow
• RecoveryFlowMethod
• RecoveryFlowMethodConfig
• RecoveryLink
• RegistrationFlow
• RegistrationFlowMethod
• RegistrationFlowMethodConfig
• RegistrationViaApiResponse
• RevokeSession
• Session
• SettingsFlow
• SettingsFlowMethod
• SettingsFlowMethodConfig
• SettingsViaApiResponse
• UpdateIdentity
• VerifiableAddress
• VerificationFlow
• VerificationFlowMethod
• VerificationFlowMethodConfig
• Version

Documentation For Authorization

sessionToken

• Type: API key
• API key parameter name: X-Session-Token
• Location: HTTP header

Author