ory_kratos_client 0.6.0-alpha.2

OpenAPI API client

ory_kratos_client

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: v0.6.0-alpha.2
• 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 createIdentity = CreateIdentity(); // CreateIdentity | 

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

Documentation for API Endpoints

All URIs are relative to https://demo.tenants.oryapis.com/api/kratos/public

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	getVersion	GET /version	Return Running Software Version.
AdminApi	isAlive	GET /health/alive	Check HTTP Server Status
AdminApi	isReady	GET /health/ready	Check HTTP Server and Database Status
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
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	Initialize Logout Flow for API Clients - Revoke a Session
PublicApi	submitSelfServiceLoginFlow	POST /self-service/login	Submit a Login Flow
PublicApi	submitSelfServiceRecoveryFlow	POST /self-service/recovery	Complete Recovery Flow
PublicApi	submitSelfServiceRecoveryFlowWithLinkMethod	POST /self-service/recovery/methods/link	Complete Recovery Flow with Link Method
PublicApi	submitSelfServiceRegistrationFlow	POST /self-service/registration	Submit a Registration Flow
PublicApi	submitSelfServiceSettingsFlow	POST /self-service/settings	Complete Settings Flow
PublicApi	submitSelfServiceVerificationFlow	POST /self-service/verification/methods/link	Complete Verification Flow
PublicApi	whoami	GET /sessions/whoami	Check Who the Current HTTP Session Belongs To

Documentation For Models

• AuthenticateOKBody
• ContainerChangeResponseItem
• ContainerCreateCreatedBody
• ContainerTopOKBody
• ContainerUpdateOKBody
• ContainerWaitOKBody
• ContainerWaitOKBodyError
• CreateIdentity
• CreateRecoveryLink
• ErrorContainer
• ErrorResponse
• GenericError
• GenericErrorPayload
• GraphDriverData
• HealthNotReadyStatus
• HealthStatus
• IdResponse
• Identity
• IdentityCredentials
• ImageDeleteResponseItem
• ImageSummary
• InlineResponse200
• InlineResponse2001
• InlineResponse503
• LoginFlow
• LoginViaApiResponse
• Meta
• Plugin
• PluginConfig
• PluginConfigArgs
• PluginConfigInterface
• PluginConfigLinux
• PluginConfigNetwork
• PluginConfigRootfs
• PluginConfigUser
• PluginDevice
• PluginEnv
• PluginInterfaceType
• PluginMount
• PluginSettings
• Port
• RecoveryAddress
• RecoveryFlow
• RecoveryLink
• RegistrationFlow
• RegistrationViaApiResponse
• RevokeSession
• ServiceUpdateResponse
• Session
• SettingsFlow
• SettingsProfileFormConfig
• SettingsViaApiResponse
• SubmitSelfServiceBrowserSettingsOIDCFlowPayload
• SubmitSelfServiceLoginFlow
• SubmitSelfServiceLoginFlowWithPasswordMethod
• SubmitSelfServiceRecoveryFlowWithLinkMethod
• SubmitSelfServiceRegistrationFlow
• SubmitSelfServiceRegistrationFlowWithPasswordMethod
• SubmitSelfServiceSettingsFlow
• SubmitSelfServiceSettingsFlowWithPasswordMethod
• SubmitSelfServiceSettingsFlowWithProfileMethod
• SubmitSelfServiceVerificationFlowWithLinkMethod
• UiContainer
• UiNode
• UiNodeAnchorAttributes
• UiNodeAttributes
• UiNodeImageAttributes
• UiNodeInputAttributes
• UiNodeInputAttributesValue
• UiNodeTextAttributes
• UiText
• UpdateIdentity
• VerifiableAddress
• VerificationFlow
• Version
• Volume
• VolumeUsageData

Documentation For Authorization

sessionCookie

• Type: API key
• API key parameter name: ory_kratos_session
• Location:

sessionToken

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

Author

[e-mail]