ory_client_client 0.0.1-alpha.1
ory_client_client: ^0.0.1-alpha.1 copied to clipboard

OpenAPI API client

ory_client_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.1
  • 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_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_client:
    path: /path/to/ory_client_client

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:ory_client_client/api.dart';

// TODO Configure HTTP Bearer authorization: oryToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('oryToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('oryToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = DefaultApi();
final createIdentity = CreateIdentity(); // CreateIdentity | 

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

Documentation for API Endpoints #

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

ClassMethodHTTP requestDescription
DefaultApicreateIdentityAdminPOST /api/kratos/admin/identitiesCreate an Identity
DefaultApicreateRecoveryLinkAdminPOST /api/kratos/admin/recovery/linkCreate a Recovery Link
DefaultApideleteIdentityAdminDELETE /api/kratos/admin/identities/{id}Delete an Identity
DefaultApigetIdentityAdminGET /api/kratos/admin/identities/{id}Get an Identity
DefaultApigetSchemaGET /api/kratos/public/schemas/{id}
DefaultApigetSchemaAdminGET /api/kratos/admin/schemas/{id}
DefaultApigetSelfServiceErrorGET /api/kratos/public/self-service/errorsGet User-Facing Self-Service Errors
DefaultApigetSelfServiceErrorAdminGET /api/kratos/admin/self-service/errorsGet User-Facing Self-Service Errors
DefaultApigetSelfServiceLoginFlowGET /api/kratos/public/self-service/login/flowsGet Login Flow
DefaultApigetSelfServiceLoginFlowAdminGET /api/kratos/admin/self-service/login/flowsGet Login Flow
DefaultApigetSelfServiceRecoveryFlowGET /api/kratos/public/self-service/recovery/flowsGet information about a recovery flow
DefaultApigetSelfServiceRecoveryFlowAdminGET /api/kratos/admin/self-service/recovery/flowsGet information about a recovery flow
DefaultApigetSelfServiceRegistrationFlowGET /api/kratos/public/self-service/registration/flowsGet Registration Flow
DefaultApigetSelfServiceRegistrationFlowAdminGET /api/kratos/admin/self-service/registration/flowsGet Registration Flow
DefaultApigetSelfServiceSettingsFlowGET /api/kratos/public/self-service/settings/flowsGet Settings Flow
DefaultApigetSelfServiceSettingsFlowAdminGET /api/kratos/admin/self-service/settings/flowsGet Settings Flow
DefaultApigetSelfServiceVerificationFlowGET /api/kratos/public/self-service/verification/flowsGet Verification Flow
DefaultApigetSelfServiceVerificationFlowAdminGET /api/kratos/admin/self-service/verification/flowsGet Verification Flow
DefaultApigetVersionAdminGET /api/kratos/admin/versionReturn Running Software Version.
DefaultApiinitializeSelfServiceBrowserLogoutFlowGET /api/kratos/public/self-service/browser/flows/logoutInitialize Browser-Based Logout User Flow
DefaultApiinitializeSelfServiceLoginViaAPIFlowGET /api/kratos/public/self-service/login/apiInitialize Login Flow for API clients
DefaultApiinitializeSelfServiceLoginViaBrowserFlowGET /api/kratos/public/self-service/login/browserInitialize Login Flow for browsers
DefaultApiinitializeSelfServiceRecoveryViaAPIFlowGET /api/kratos/public/self-service/recovery/apiInitialize Recovery Flow for API Clients
DefaultApiinitializeSelfServiceRecoveryViaBrowserFlowGET /api/kratos/public/self-service/recovery/browserInitialize Recovery Flow for Browser Clients
DefaultApiinitializeSelfServiceRegistrationGET /api/kratos/public/self-service/registration/apiInitialize Registration Flow for API clients
DefaultApiinitializeSelfServiceRegistrationForBrowsersGET /api/kratos/public/self-service/registration/browserInitialize Registration Flow for browsers
DefaultApiinitializeSelfServiceSettingsViaAPIFlowGET /api/kratos/public/self-service/settings/apiInitialize Settings Flow for API Clients
DefaultApiinitializeSelfServiceSettingsViaBrowserFlowGET /api/kratos/public/self-service/settings/browserInitialize Settings Flow for Browsers
DefaultApiinitializeSelfServiceVerificationViaAPIFlowGET /api/kratos/public/self-service/verification/apiInitialize Verification Flow for API Clients
DefaultApiinitializeSelfServiceVerificationViaBrowserFlowGET /api/kratos/public/self-service/verification/browserInitialize Verification Flow for Browser Clients
DefaultApiisAliveAdminGET /api/kratos/admin/health/aliveCheck HTTP Server Status
DefaultApiisReadyAdminGET /api/kratos/admin/health/readyCheck HTTP Server and Database Status
DefaultApilistIdentitiesAdminGET /api/kratos/admin/identitiesList Identities
DefaultApiprometheusAdminGET /api/kratos/admin/metrics/prometheusGet snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
DefaultApirevokeSessionDELETE /api/kratos/public/sessionsInitialize Logout Flow for API Clients - Revoke a Session
DefaultApisubmitSelfServiceLoginFlowPOST /api/kratos/public/self-service/loginSubmit a Login Flow
DefaultApisubmitSelfServiceRecoveryFlowPOST /api/kratos/public/self-service/recoveryComplete Recovery Flow
DefaultApisubmitSelfServiceRecoveryFlowWithLinkMethodPOST /api/kratos/public/self-service/recovery/methods/linkComplete Recovery Flow with Link Method
DefaultApisubmitSelfServiceRegistrationFlowPOST /api/kratos/public/self-service/registrationSubmit a Registration Flow
DefaultApisubmitSelfServiceSettingsFlowPOST /api/kratos/public/self-service/settingsComplete Settings Flow
DefaultApisubmitSelfServiceVerificationFlowPOST /api/kratos/public/self-service/verification/methods/linkComplete Verification Flow
DefaultApitoSessionGET /api/kratos/public/sessions/whoamiCheck Who the Current HTTP Session Belongs To
DefaultApiupdateIdentityAdminPUT /api/kratos/admin/identities/{id}Update an Identity

Documentation For Models #

Documentation For Authorization #

oryToken #

  • Type: HTTP Bearer authentication

sessionCookie #

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

sessionToken #

  • Type: HTTP Bearer authentication

Author #

support@ory.sh

0
likes
55
pub points
0%
popularity

OpenAPI API client

Homepage

Documentation

API reference

License

Apache-2.0 (LICENSE)

Dependencies

http, intl, meta

More

Packages that depend on ory_client_client