ory_kratos_client 0.0.0 ory_kratos_client: ^0.0.0 copied to clipboard
OpenAPI API client
ory_kratos_client #
Welcome to the ORY Kratos HTTP API documentation!
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.0.0
- 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 = HealthApi();
try {
final result = api_instance.isInstanceAlive();
print(result);
} catch (e) {
print('Exception when calling HealthApi->isInstanceAlive: $e\n');
}
Documentation for API Endpoints #
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
HealthApi | isInstanceAlive | GET /health/alive | Check alive status |
HealthApi | isInstanceReady | GET /health/ready | Check readiness status |
PublicApi | completeProfileManagementFlow | POST /profiles | Complete Profile Management Flow |
PublicApi | getLoginRequest | GET /auth/browser/requests/login | Get Login Request |
PublicApi | getProfileManagementRequest | GET /profiles/requests | Get Profile Management Request (via cookie) |
PublicApi | getRegistrationRequest | GET /auth/browser/requests/registration | Get Registration Request |
PublicApi | initializeLoginFlow | GET /auth/browser/login | Initialize a Login Flow |
PublicApi | initializeProfileManagementFlow | GET /profiles | Initialize Profile Management Flow |
PublicApi | initializeRegistrationFlow | GET /auth/browser/registration | Initialize a Registration Flow |
VersionApi | getVersion | GET /version | Get service version |
Documentation For Models #
- Error
- Form
- FormField
- GenericError
- HealthNotReadyStatus
- HealthStatus
- Identity
- LoginRequest
- LoginRequestMethod
- LoginRequestMethodConfig
- OidcStrategyCredentialsConfig
- OidcStrategyRequestMethod
- ProfileManagementRequest
- RegistrationRequest
- RegistrationRequestMethod
- RegistrationRequestMethodConfig
- Version
Documentation For Authorization #
All endpoints do not require authorization.