ory_kratos_client

Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.

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

  • API version: v0.10.1
  • 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_kratos_client
version: 0.10.1
description: OpenAPI API client
dependencies:
  ory_kratos_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_kratos_client:
    path: /path/to/ory_kratos_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_kratos_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 http://localhost

ClassMethodHTTP requestDescription
MetadataApigetVersionGET /versionReturn Running Software Version.
MetadataApiisAliveGET /health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /health/readyCheck HTTP Server and Database Status
V0alpha2ApiadminCreateIdentityPOST /admin/identitiesCreate an Identity
V0alpha2ApiadminCreateSelfServiceRecoveryLinkPOST /admin/recovery/linkCreate a Recovery Link
V0alpha2ApiadminDeleteIdentityDELETE /admin/identities/{id}Delete an Identity
V0alpha2ApiadminDeleteIdentitySessionsDELETE /admin/identities/{id}/sessionsCalling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2ApiadminExtendSessionPATCH /admin/sessions/{id}/extendCalling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it will only extend the session after the specified time has passed.
V0alpha2ApiadminGetIdentityGET /admin/identities/{id}Get an Identity
V0alpha2ApiadminListIdentitiesGET /admin/identitiesList Identities
V0alpha2ApiadminListIdentitySessionsGET /admin/identities/{id}/sessionsThis endpoint returns all sessions that belong to the given Identity.
V0alpha2ApiadminUpdateIdentityPUT /admin/identities/{id}Update an Identity
V0alpha2ApicreateSelfServiceLogoutFlowUrlForBrowsersGET /self-service/logout/browserCreate a Logout URL for Browsers
V0alpha2ApigetJsonSchemaGET /schemas/{id}
V0alpha2ApigetSelfServiceErrorGET /self-service/errorsGet Self-Service Errors
V0alpha2ApigetSelfServiceLoginFlowGET /self-service/login/flowsGet Login Flow
V0alpha2ApigetSelfServiceRecoveryFlowGET /self-service/recovery/flowsGet Recovery Flow
V0alpha2ApigetSelfServiceRegistrationFlowGET /self-service/registration/flowsGet Registration Flow
V0alpha2ApigetSelfServiceSettingsFlowGET /self-service/settings/flowsGet Settings Flow
V0alpha2ApigetSelfServiceVerificationFlowGET /self-service/verification/flowsGet Verification Flow
V0alpha2ApigetWebAuthnJavaScriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
V0alpha2ApiinitializeSelfServiceLoginFlowForBrowsersGET /self-service/login/browserInitialize Login Flow for Browsers
V0alpha2ApiinitializeSelfServiceLoginFlowWithoutBrowserGET /self-service/login/apiInitialize Login Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRecoveryFlowForBrowsersGET /self-service/recovery/browserInitialize Recovery Flow for Browsers
V0alpha2ApiinitializeSelfServiceRecoveryFlowWithoutBrowserGET /self-service/recovery/apiInitialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRegistrationFlowForBrowsersGET /self-service/registration/browserInitialize Registration Flow for Browsers
V0alpha2ApiinitializeSelfServiceRegistrationFlowWithoutBrowserGET /self-service/registration/apiInitialize Registration Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceSettingsFlowForBrowsersGET /self-service/settings/browserInitialize Settings Flow for Browsers
V0alpha2ApiinitializeSelfServiceSettingsFlowWithoutBrowserGET /self-service/settings/apiInitialize Settings Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceVerificationFlowForBrowsersGET /self-service/verification/browserInitialize Verification Flow for Browser Clients
V0alpha2ApiinitializeSelfServiceVerificationFlowWithoutBrowserGET /self-service/verification/apiInitialize Verification Flow for APIs, Services, Apps, ...
V0alpha2ApilistIdentitySchemasGET /schemas
V0alpha2ApilistSessionsGET /sessionsThis endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint.
V0alpha2ApirevokeSessionDELETE /sessions/{id}Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
V0alpha2ApirevokeSessionsDELETE /sessionsCalling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
V0alpha2ApisubmitSelfServiceLoginFlowPOST /self-service/loginSubmit a Login Flow
V0alpha2ApisubmitSelfServiceLogoutFlowGET /self-service/logoutComplete Self-Service Logout
V0alpha2ApisubmitSelfServiceLogoutFlowWithoutBrowserDELETE /self-service/logout/apiPerform Logout for APIs, Services, Apps, ...
V0alpha2ApisubmitSelfServiceRecoveryFlowPOST /self-service/recoveryComplete Recovery Flow
V0alpha2ApisubmitSelfServiceRegistrationFlowPOST /self-service/registrationSubmit a Registration Flow
V0alpha2ApisubmitSelfServiceSettingsFlowPOST /self-service/settingsComplete Settings Flow
V0alpha2ApisubmitSelfServiceVerificationFlowPOST /self-service/verificationComplete Verification Flow
V0alpha2ApitoSessionGET /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

hi@ory.sh

Libraries

admin_create_identity_body
admin_create_identity_import_credentials_oidc
admin_create_identity_import_credentials_oidc_config
admin_create_identity_import_credentials_oidc_provider
admin_create_identity_import_credentials_password
admin_create_identity_import_credentials_password_config
admin_identity_import_credentials
admin_update_identity_body
api_key_auth
api_util
auth
authenticator_assurance_level
basic_auth
error_authenticator_assurance_level_not_satisfied
generic_error
health_not_ready_status
health_status
identity
identity_credentials
identity_credentials_oidc
identity_credentials_oidc_provider
identity_credentials_password
identity_credentials_type
identity_schema
identity_state
inline_response200
inline_response503
inline_response2001
json_error
metadata_api
needs_privileged_session_error
oauth
ory_kratos_client.api
pagination
recovery_address
revoked_sessions
self_service_browser_location_change_required_error
self_service_error
self_service_flow_expired_error
self_service_login_flow
self_service_logout_url
self_service_recovery_flow
self_service_recovery_flow_state
self_service_registration_flow
self_service_settings_flow
self_service_settings_flow_state
self_service_verification_flow
self_service_verification_flow_state
serializers
session
session_authentication_method
session_device
settings_profile_form_config
submit_self_service_flow_with_web_authn_registration_method
submit_self_service_login_flow_body
submit_self_service_login_flow_with_lookup_secret_method_body
submit_self_service_login_flow_with_oidc_method_body
submit_self_service_login_flow_with_password_method_body
submit_self_service_login_flow_with_totp_method_body
submit_self_service_login_flow_with_web_authn_method_body
submit_self_service_logout_flow_without_browser_body
submit_self_service_recovery_flow_body
submit_self_service_registration_flow_body
submit_self_service_registration_flow_with_oidc_method_body
submit_self_service_registration_flow_with_password_method_body
submit_self_service_registration_flow_with_web_authn_method_body
submit_self_service_settings_flow_body
submit_self_service_settings_flow_with_lookup_method_body
submit_self_service_settings_flow_with_oidc_method_body
submit_self_service_settings_flow_with_password_method_body
submit_self_service_settings_flow_with_profile_method_body
submit_self_service_settings_flow_with_totp_method_body
submit_self_service_settings_flow_with_web_authn_method_body
submit_self_service_verification_flow_body
successful_self_service_login_without_browser
successful_self_service_registration_without_browser
ui_container
ui_node
ui_node_anchor_attributes
ui_node_attributes
ui_node_image_attributes
ui_node_input_attributes
ui_node_meta
ui_node_script_attributes
ui_node_text_attributes
ui_text
v0alpha2_api
verifiable_identity_address
version