ory_client_client

Description:

ory client 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
copied to clipboard
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
copied to clipboard
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');
}

copied to clipboard
Documentation for API Endpoints #
All URIs are relative to https://playground.projects.oryapis.com



Class
Method
HTTP request
Description




DefaultApi
createIdentityAdmin
POST /api/kratos/admin/identities
Create an Identity


DefaultApi
createRecoveryLinkAdmin
POST /api/kratos/admin/recovery/link
Create a Recovery Link


DefaultApi
deleteIdentityAdmin
DELETE /api/kratos/admin/identities/{id}
Delete an Identity


DefaultApi
getIdentityAdmin
GET /api/kratos/admin/identities/{id}
Get an Identity


DefaultApi
getSchema
GET /api/kratos/public/schemas/{id}



DefaultApi
getSchemaAdmin
GET /api/kratos/admin/schemas/{id}



DefaultApi
getSelfServiceError
GET /api/kratos/public/self-service/errors
Get User-Facing Self-Service Errors


DefaultApi
getSelfServiceErrorAdmin
GET /api/kratos/admin/self-service/errors
Get User-Facing Self-Service Errors


DefaultApi
getSelfServiceLoginFlow
GET /api/kratos/public/self-service/login/flows
Get Login Flow


DefaultApi
getSelfServiceLoginFlowAdmin
GET /api/kratos/admin/self-service/login/flows
Get Login Flow


DefaultApi
getSelfServiceRecoveryFlow
GET /api/kratos/public/self-service/recovery/flows
Get information about a recovery flow


DefaultApi
getSelfServiceRecoveryFlowAdmin
GET /api/kratos/admin/self-service/recovery/flows
Get information about a recovery flow


DefaultApi
getSelfServiceRegistrationFlow
GET /api/kratos/public/self-service/registration/flows
Get Registration Flow


DefaultApi
getSelfServiceRegistrationFlowAdmin
GET /api/kratos/admin/self-service/registration/flows
Get Registration Flow


DefaultApi
getSelfServiceSettingsFlow
GET /api/kratos/public/self-service/settings/flows
Get Settings Flow


DefaultApi
getSelfServiceSettingsFlowAdmin
GET /api/kratos/admin/self-service/settings/flows
Get Settings Flow


DefaultApi
getSelfServiceVerificationFlow
GET /api/kratos/public/self-service/verification/flows
Get Verification Flow


DefaultApi
getSelfServiceVerificationFlowAdmin
GET /api/kratos/admin/self-service/verification/flows
Get Verification Flow


DefaultApi
getVersionAdmin
GET /api/kratos/admin/version
Return Running Software Version.


DefaultApi
initializeSelfServiceBrowserLogoutFlow
GET /api/kratos/public/self-service/browser/flows/logout
Initialize Browser-Based Logout User Flow


DefaultApi
initializeSelfServiceLoginViaAPIFlow
GET /api/kratos/public/self-service/login/api
Initialize Login Flow for API clients


DefaultApi
initializeSelfServiceLoginViaBrowserFlow
GET /api/kratos/public/self-service/login/browser
Initialize Login Flow for browsers


DefaultApi
initializeSelfServiceRecoveryViaAPIFlow
GET /api/kratos/public/self-service/recovery/api
Initialize Recovery Flow for API Clients


DefaultApi
initializeSelfServiceRecoveryViaBrowserFlow
GET /api/kratos/public/self-service/recovery/browser
Initialize Recovery Flow for Browser Clients


DefaultApi
initializeSelfServiceRegistration
GET /api/kratos/public/self-service/registration/api
Initialize Registration Flow for API clients


DefaultApi
initializeSelfServiceRegistrationForBrowsers
GET /api/kratos/public/self-service/registration/browser
Initialize Registration Flow for browsers


DefaultApi
initializeSelfServiceSettingsViaAPIFlow
GET /api/kratos/public/self-service/settings/api
Initialize Settings Flow for API Clients


DefaultApi
initializeSelfServiceSettingsViaBrowserFlow
GET /api/kratos/public/self-service/settings/browser
Initialize Settings Flow for Browsers


DefaultApi
initializeSelfServiceVerificationViaAPIFlow
GET /api/kratos/public/self-service/verification/api
Initialize Verification Flow for API Clients


DefaultApi
initializeSelfServiceVerificationViaBrowserFlow
GET /api/kratos/public/self-service/verification/browser
Initialize Verification Flow for Browser Clients


DefaultApi
isAliveAdmin
GET /api/kratos/admin/health/alive
Check HTTP Server Status


DefaultApi
isReadyAdmin
GET /api/kratos/admin/health/ready
Check HTTP Server and Database Status


DefaultApi
listIdentitiesAdmin
GET /api/kratos/admin/identities
List Identities


DefaultApi
prometheusAdmin
GET /api/kratos/admin/metrics/prometheus
Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:


DefaultApi
revokeSession
DELETE /api/kratos/public/sessions
Initialize Logout Flow for API Clients - Revoke a Session


DefaultApi
submitSelfServiceLoginFlow
POST /api/kratos/public/self-service/login
Submit a Login Flow


DefaultApi
submitSelfServiceRecoveryFlow
POST /api/kratos/public/self-service/recovery
Complete Recovery Flow


DefaultApi
submitSelfServiceRecoveryFlowWithLinkMethod
POST /api/kratos/public/self-service/recovery/methods/link
Complete Recovery Flow with Link Method


DefaultApi
submitSelfServiceRegistrationFlow
POST /api/kratos/public/self-service/registration
Submit a Registration Flow


DefaultApi
submitSelfServiceSettingsFlow
POST /api/kratos/public/self-service/settings
Complete Settings Flow


DefaultApi
submitSelfServiceVerificationFlow
POST /api/kratos/public/self-service/verification/methods/link
Complete Verification Flow


DefaultApi
toSession
GET /api/kratos/public/sessions/whoami
Check Who the Current HTTP Session Belongs To


DefaultApi
updateIdentityAdmin
PUT /api/kratos/admin/identities/{id}
Update an Identity



Documentation For Models #

AuthenticateOKBody
ContainerChangeResponseItem
ContainerCreateCreatedBody
ContainerTopOKBody
ContainerUpdateOKBody
ContainerWaitOKBody
ContainerWaitOKBodyError
CreateIdentity
CreateRecoveryLink
ErrorContainer
ErrorResponse
GenericError
GraphDriverData
HealthNotReadyStatus
HealthStatus
IdResponse
Identity
IdentityCredentials
ImageDeleteResponseItem
ImageSummary
InlineResponse200
InlineResponse2001
InlineResponse503
JsonError
LoginFlow
LoginViaApiResponse
Meta
Plugin
PluginConfig
PluginConfigArgs
PluginConfigInterface
PluginConfigLinux
PluginConfigNetwork
PluginConfigRootfs
PluginConfigUser
PluginDevice
PluginEnv
PluginInterfaceType
PluginMount
PluginSettings
Port
RecoveryAddress
RecoveryFlow
RecoveryLink
RegistrationFlow
RegistrationViaApiResponse
RevokeSession
ServiceUpdateResponse
Session
SettingsFlow
SettingsProfileFormConfig
SettingsViaApiResponse
SubmitSelfServiceBrowserSettingsOIDCFlowPayload
SubmitSelfServiceLoginFlow
SubmitSelfServiceLoginFlowWithPasswordMethod
SubmitSelfServiceRecoveryFlowWithLinkMethod
SubmitSelfServiceRegistrationFlow
SubmitSelfServiceRegistrationFlowWithPasswordMethod
SubmitSelfServiceSettingsFlow
SubmitSelfServiceSettingsFlowWithPasswordMethod
SubmitSelfServiceSettingsFlowWithProfileMethod
SubmitSelfServiceVerificationFlowWithLinkMethod
UiContainer
UiNode
UiNodeAnchorAttributes
UiNodeAttributes
UiNodeImageAttributes
UiNodeInputAttributes
UiNodeInputAttributesValue
UiNodeTextAttributes
UiText
UpdateIdentity
VerifiableIdentityAddress
VerificationFlow
Version
Volume
VolumeUsageData

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 #
[email protected]