ory_client 0.0.1-alpha.17

OpenAPI API client

ory_client

Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.

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

• API version: v0.0.1-alpha.17
• 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_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_client:
    path: /path/to/ory_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_client/api.dart';


final api_instance = MetadataApi();

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

Documentation for API Endpoints

All URIs are relative to https://playground.projects.oryapis.com

Class	Method	HTTP request	Description
MetadataApi	getVersion	GET /api/kratos/public/version	Return Running Software Version.
MetadataApi	isAlive	GET /api/kratos/public/health/alive	Check HTTP Server Status
MetadataApi	isReady	GET /api/kratos/public/health/ready	Check HTTP Server and Database Status
MetadataApi	prometheus	GET /api/kratos/public/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 /api/kratos/admin/identities	Create an Identity
V0alpha1Api	adminCreateSelfServiceRecoveryLink	POST /api/kratos/admin/recovery/link	Create a Recovery Link
V0alpha1Api	adminDeleteIdentity	DELETE /api/kratos/admin/identities/{id}	Delete an Identity
V0alpha1Api	adminGetIdentity	GET /api/kratos/admin/identities/{id}	Get an Identity
V0alpha1Api	adminListIdentities	GET /api/kratos/admin/identities	List Identities
V0alpha1Api	adminUpdateIdentity	PUT /api/kratos/admin/identities/{id}	Update an Identity
V0alpha1Api	createSelfServiceLogoutFlowUrlForBrowsers	GET /api/kratos/public/self-service/logout/browser	Create a Logout URL for Browsers
V0alpha1Api	getJsonSchema	GET /api/kratos/public/schemas/{id}
V0alpha1Api	getSelfServiceError	GET /api/kratos/public/self-service/errors	Get Self-Service Errors
V0alpha1Api	getSelfServiceLoginFlow	GET /api/kratos/public/self-service/login/flows	Get Login Flow
V0alpha1Api	getSelfServiceRecoveryFlow	GET /api/kratos/public/self-service/recovery/flows	Get Recovery Flow
V0alpha1Api	getSelfServiceRegistrationFlow	GET /api/kratos/public/self-service/registration/flows	Get Registration Flow
V0alpha1Api	getSelfServiceSettingsFlow	GET /api/kratos/public/self-service/settings/flows	Get Settings Flow
V0alpha1Api	getSelfServiceVerificationFlow	GET /api/kratos/public/self-service/verification/flows	Get Verification Flow
V0alpha1Api	initializeSelfServiceLoginFlowForBrowsers	GET /api/kratos/public/self-service/login/browser	Initialize Login Flow for Browsers
V0alpha1Api	initializeSelfServiceLoginFlowWithoutBrowser	GET /api/kratos/public/self-service/login/api	Initialize Login Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceRecoveryFlowForBrowsers	GET /api/kratos/public/self-service/recovery/browser	Initialize Recovery Flow for Browsers
V0alpha1Api	initializeSelfServiceRecoveryFlowWithoutBrowser	GET /api/kratos/public/self-service/recovery/api	Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceRegistrationFlowForBrowsers	GET /api/kratos/public/self-service/registration/browser	Initialize Registration Flow for Browsers
V0alpha1Api	initializeSelfServiceRegistrationFlowWithoutBrowser	GET /api/kratos/public/self-service/registration/api	Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceSettingsFlowForBrowsers	GET /api/kratos/public/self-service/settings/browser	Initialize Settings Flow for Browsers
V0alpha1Api	initializeSelfServiceSettingsFlowWithoutBrowser	GET /api/kratos/public/self-service/settings/api	Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha1Api	initializeSelfServiceVerificationFlowForBrowsers	GET /api/kratos/public/self-service/verification/browser	Initialize Verification Flow for Browser Clients
V0alpha1Api	initializeSelfServiceVerificationFlowWithoutBrowser	GET /api/kratos/public/self-service/verification/api	Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha1Api	submitSelfServiceLoginFlow	POST /api/kratos/public/self-service/login	Submit a Login Flow
V0alpha1Api	submitSelfServiceLogoutFlow	GET /api/kratos/public/self-service/logout	Complete Self-Service Logout
V0alpha1Api	submitSelfServiceLogoutFlowWithoutBrowser	DELETE /api/kratos/public/self-service/logout/api	Perform Logout for APIs, Services, Apps, ...
V0alpha1Api	submitSelfServiceRecoveryFlow	POST /api/kratos/public/self-service/recovery	Complete Recovery Flow
V0alpha1Api	submitSelfServiceRegistrationFlow	POST /api/kratos/public/self-service/registration	Submit a Registration Flow
V0alpha1Api	submitSelfServiceSettingsFlow	POST /api/kratos/public/self-service/settings	Complete Settings Flow
V0alpha1Api	submitSelfServiceVerificationFlow	POST /api/kratos/public/self-service/verification	Complete Verification Flow
V0alpha1Api	toSession	GET /api/kratos/public/sessions/whoami	Check Who the Current HTTP Session Belongs To

Documentation For Models

• AdminCreateIdentityBody
• AdminCreateSelfServiceRecoveryLinkBody
• AdminUpdateIdentityBody
• AuthenticateOKBody
• ContainerChangeResponseItem
• ContainerCreateCreatedBody
• ContainerTopOKBody
• ContainerUpdateOKBody
• ContainerWaitOKBody
• ContainerWaitOKBodyError
• ErrorResponse
• GenericError
• GraphDriverData
• HealthNotReadyStatus
• HealthStatus
• IdResponse
• Identity
• IdentityCredentials
• IdentityState
• ImageDeleteResponseItem
• ImageSummary
• InlineResponse200
• InlineResponse2001
• InlineResponse503
• JsonError
• Meta
• Plugin
• PluginConfig
• PluginConfigArgs
• PluginConfigInterface
• PluginConfigLinux
• PluginConfigNetwork
• PluginConfigRootfs
• PluginConfigUser
• PluginDevice
• PluginEnv
• PluginInterfaceType
• PluginMount
• PluginSettings
• Port
• RecoveryAddress
• SelfServiceError
• SelfServiceLoginFlow
• SelfServiceLogoutUrl
• SelfServiceRecoveryFlow
• SelfServiceRecoveryFlowState
• SelfServiceRecoveryLink
• SelfServiceRegistrationFlow
• SelfServiceSettingsFlow
• SelfServiceSettingsFlowState
• SelfServiceVerificationFlow
• SelfServiceVerificationFlowState
• ServiceUpdateResponse
• 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
• Volume
• VolumeUsageData

Documentation For Authorization

oryAccessToken

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

Author

[e-mail]