ory_kratos_client 0.7.6-alpha.7

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.7.6-alpha.7
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Dart 2.7.0 or later OR Flutter 1.12 or later

Installation & Usage

Github

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

name: ory_kratos_client
version: 0.7.6-alpha.7
description: OpenAPI API client
dependencies:
  ory_kratos_client:
    git: https://github.com/ory/sdk.git
      version: 'any'

Local

To use the package in 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/api.dart';


final api = MetadataApi();

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
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
MetadataApi	prometheus	GET /metrics/prometheus	Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
V0alpha1Api	adminCreateIdentity	POST /identities	Create an Identity
V0alpha1Api	adminCreateSelfServiceRecoveryLink	POST /recovery/link	Create a Recovery Link
V0alpha1Api	adminDeleteIdentity	DELETE /identities/{id}	Delete an Identity
V0alpha1Api	adminGetIdentity	GET /identities/{id}	Get an Identity
V0alpha1Api	adminListIdentities	GET /identities	List Identities
V0alpha1Api	adminUpdateIdentity	PUT /identities/{id}	Update an Identity
V0alpha1Api	createSelfServiceLogoutFlowUrlForBrowsers	GET /self-service/logout/browser	Create a Logout URL for Browsers
V0alpha1Api	getJsonSchema	GET /schemas/{id}
V0alpha1Api	getSelfServiceError	GET /self-service/errors	Get Self-Service Errors
V0alpha1Api	getSelfServiceLoginFlow	GET /self-service/login/flows	Get Login Flow
V0alpha1Api	getSelfServiceRecoveryFlow	GET /self-service/recovery/flows	Get Recovery Flow
V0alpha1Api	getSelfServiceRegistrationFlow	GET /self-service/registration/flows	Get Registration Flow
V0alpha1Api	getSelfServiceSettingsFlow	GET /self-service/settings/flows	Get Settings Flow
V0alpha1Api	getSelfServiceVerificationFlow	GET /self-service/verification/flows	Get Verification Flow
V0alpha1Api	initializeSelfServiceLoginFlowForBrowsers	GET /self-service/login/browser	Initialize Login Flow for Browsers
V0alpha1Api	initializeSelfServiceLoginFlowWithoutBrowser	GET /self-service/login/api	Initialize Login Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceRecoveryFlowForBrowsers	GET /self-service/recovery/browser	Initialize Recovery Flow for Browsers
V0alpha1Api	initializeSelfServiceRecoveryFlowWithoutBrowser	GET /self-service/recovery/api	Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceRegistrationFlowForBrowsers	GET /self-service/registration/browser	Initialize Registration Flow for Browsers
V0alpha1Api	initializeSelfServiceRegistrationFlowWithoutBrowser	GET /self-service/registration/api	Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceSettingsFlowForBrowsers	GET /self-service/settings/browser	Initialize Settings Flow for Browsers
V0alpha1Api	initializeSelfServiceSettingsFlowWithoutBrowser	GET /self-service/settings/api	Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceVerificationFlowForBrowsers	GET /self-service/verification/browser	Initialize Verification Flow for Browser Clients
V0alpha1Api	initializeSelfServiceVerificationFlowWithoutBrowser	GET /self-service/verification/api	Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha1Api	submitSelfServiceLoginFlow	POST /self-service/login	Submit a Login Flow
V0alpha1Api	submitSelfServiceLogoutFlow	GET /self-service/logout	Complete Self-Service Logout
V0alpha1Api	submitSelfServiceLogoutFlowWithoutBrowser	DELETE /self-service/logout/api	Perform Logout for APIs, Services, Apps, ...
V0alpha1Api	submitSelfServiceRecoveryFlow	POST /self-service/recovery	Complete Recovery Flow
V0alpha1Api	submitSelfServiceRegistrationFlow	POST /self-service/registration	Submit a Registration Flow
V0alpha1Api	submitSelfServiceSettingsFlow	POST /self-service/settings	Complete Settings Flow
V0alpha1Api	submitSelfServiceVerificationFlow	POST /self-service/verification	Complete Verification Flow
V0alpha1Api	toSession	GET /sessions/whoami	Check Who the Current HTTP Session Belongs To

Documentation For Models

• AdminCreateIdentityBody
• AdminCreateSelfServiceRecoveryLinkBody
• AdminUpdateIdentityBody
• GenericError
• HealthNotReadyStatus
• HealthStatus
• Identity
• IdentityCredentials
• IdentityState
• InlineResponse200
• InlineResponse2001
• InlineResponse503
• JsonError
• Meta
• RecoveryAddress
• SelfServiceError
• SelfServiceLoginFlow
• SelfServiceLogoutUrl
• SelfServiceRecoveryFlow
• SelfServiceRecoveryFlowState
• SelfServiceRecoveryLink
• SelfServiceRegistrationFlow
• SelfServiceSettingsFlow
• SelfServiceSettingsFlowState
• SelfServiceVerificationFlow
• SelfServiceVerificationFlowState
• Session
• SettingsProfileFormConfig
• SubmitSelfServiceLoginFlowBody
• SubmitSelfServiceLoginFlowWithOidcMethodBody
• SubmitSelfServiceLoginFlowWithPasswordMethodBody
• SubmitSelfServiceLogoutFlowWithoutBrowserBody
• SubmitSelfServiceRecoveryFlowBody
• SubmitSelfServiceRecoveryFlowWithLinkMethodBody
• SubmitSelfServiceRegistrationFlowBody
• SubmitSelfServiceRegistrationFlowWithOidcMethodBody
• SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
• SubmitSelfServiceSettingsFlowBody
• SubmitSelfServiceSettingsFlowWithOidcMethodBody
• SubmitSelfServiceSettingsFlowWithPasswordMethodBody
• SubmitSelfServiceSettingsFlowWithProfileMethodBody
• SubmitSelfServiceVerificationFlowBody
• SubmitSelfServiceVerificationFlowWithLinkMethodBody
• SuccessfulSelfServiceLoginWithoutBrowser
• SuccessfulSelfServiceRegistrationWithoutBrowser
• SuccessfulSelfServiceSettingsWithoutBrowser
• UiContainer
• UiNode
• UiNodeAnchorAttributes
• UiNodeAttributes
• UiNodeImageAttributes
• UiNodeInputAttributes
• UiNodeTextAttributes
• UiText
• VerifiableIdentityAddress
• Version

Documentation For Authorization

oryAccessToken

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

Author

[e-mail]