ory_client 0.0.1-alpha.21
ory_client: ^0.0.1-alpha.21 copied to clipboard

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.21
  • 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_client
version: 0.0.1-alpha.21
description: OpenAPI API client
dependencies:
  ory_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_client:
    path: /path/to/ory_client

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:ory_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 https://playground.projects.oryapis.com

ClassMethodHTTP requestDescription
MetadataApigetVersionGET /api/kratos/public/versionReturn Running Software Version.
MetadataApiisAliveGET /api/kratos/public/health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /api/kratos/public/health/readyCheck HTTP Server and Database Status
MetadataApiprometheusGET /api/kratos/public/metrics/prometheusGet snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
V0alpha2ApiadminCreateIdentityPOST /api/kratos/admin/identitiesCreate an Identity
V0alpha2ApiadminCreateSelfServiceRecoveryLinkPOST /api/kratos/admin/recovery/linkCreate a Recovery Link
V0alpha2ApiadminDeleteIdentityDELETE /api/kratos/admin/identities/{id}Delete an Identity
V0alpha2ApiadminDeleteIdentitySessionsDELETE /api/kratos/admin/identities/{id}/sessionsCalling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2ApiadminGetIdentityGET /api/kratos/admin/identities/{id}Get an Identity
V0alpha2ApiadminListIdentitiesGET /api/kratos/admin/identitiesList Identities
V0alpha2ApiadminUpdateIdentityPUT /api/kratos/admin/identities/{id}Update an Identity
V0alpha2ApicreateSelfServiceLogoutFlowUrlForBrowsersGET /api/kratos/public/self-service/logout/browserCreate a Logout URL for Browsers
V0alpha2ApigetJsonSchemaGET /api/kratos/public/schemas/{id}
V0alpha2ApigetSelfServiceErrorGET /api/kratos/public/self-service/errorsGet Self-Service Errors
V0alpha2ApigetSelfServiceLoginFlowGET /api/kratos/public/self-service/login/flowsGet Login Flow
V0alpha2ApigetSelfServiceRecoveryFlowGET /api/kratos/public/self-service/recovery/flowsGet Recovery Flow
V0alpha2ApigetSelfServiceRegistrationFlowGET /api/kratos/public/self-service/registration/flowsGet Registration Flow
V0alpha2ApigetSelfServiceSettingsFlowGET /api/kratos/public/self-service/settings/flowsGet Settings Flow
V0alpha2ApigetSelfServiceVerificationFlowGET /api/kratos/public/self-service/verification/flowsGet Verification Flow
V0alpha2ApigetWebAuthnJavaScriptGET /api/kratos/public/.well-known/ory/webauthn.jsGet WebAuthn JavaScript
V0alpha2ApiinitializeSelfServiceLoginFlowForBrowsersGET /api/kratos/public/self-service/login/browserInitialize Login Flow for Browsers
V0alpha2ApiinitializeSelfServiceLoginFlowWithoutBrowserGET /api/kratos/public/self-service/login/apiInitialize Login Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRecoveryFlowForBrowsersGET /api/kratos/public/self-service/recovery/browserInitialize Recovery Flow for Browsers
V0alpha2ApiinitializeSelfServiceRecoveryFlowWithoutBrowserGET /api/kratos/public/self-service/recovery/apiInitialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRegistrationFlowForBrowsersGET /api/kratos/public/self-service/registration/browserInitialize Registration Flow for Browsers
V0alpha2ApiinitializeSelfServiceRegistrationFlowWithoutBrowserGET /api/kratos/public/self-service/registration/apiInitialize Registration Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceSettingsFlowForBrowsersGET /api/kratos/public/self-service/settings/browserInitialize Settings Flow for Browsers
V0alpha2ApiinitializeSelfServiceSettingsFlowWithoutBrowserGET /api/kratos/public/self-service/settings/apiInitialize Settings Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceVerificationFlowForBrowsersGET /api/kratos/public/self-service/verification/browserInitialize Verification Flow for Browser Clients
V0alpha2ApiinitializeSelfServiceVerificationFlowWithoutBrowserGET /api/kratos/public/self-service/verification/apiInitialize Verification Flow for APIs, Services, Apps, ...
V0alpha2ApilistIdentitySchemasGET /api/kratos/public/schemas
V0alpha2ApisubmitSelfServiceLoginFlowPOST /api/kratos/public/self-service/loginSubmit a Login Flow
V0alpha2ApisubmitSelfServiceLogoutFlowGET /api/kratos/public/self-service/logoutComplete Self-Service Logout
V0alpha2ApisubmitSelfServiceLogoutFlowWithoutBrowserDELETE /api/kratos/public/self-service/logout/apiPerform Logout for APIs, Services, Apps, ...
V0alpha2ApisubmitSelfServiceRecoveryFlowPOST /api/kratos/public/self-service/recoveryComplete Recovery Flow
V0alpha2ApisubmitSelfServiceRegistrationFlowPOST /api/kratos/public/self-service/registrationSubmit a Registration Flow
V0alpha2ApisubmitSelfServiceSettingsFlowPOST /api/kratos/public/self-service/settingsComplete Settings Flow
V0alpha2ApisubmitSelfServiceVerificationFlowPOST /api/kratos/public/self-service/verificationComplete Verification Flow
V0alpha2ApitoSessionGET /api/kratos/public/sessions/whoamiCheck Who the Current HTTP Session Belongs To

Documentation For Models #

Documentation For Authorization #

oryAccessToken #

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

Author #

support@ory.sh