ory_kratos_client 0.9.0-alpha.3 copy "ory_kratos_client: ^0.9.0-alpha.3" to clipboard
ory_kratos_client: ^0.9.0-alpha.3 copied to clipboard

Published 2 years ago • verified publisherory.shDart 3 incompatible• Latest: 1.1.0
outdated
→

Metadata

OpenAPI API client

More...

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.9.0-alpha.3
  • 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.9.0-alpha.3
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

Class Method HTTP request Description
MetadataApi getVersion GET /version Return Running Software Version.
MetadataApi isAlive GET /health/alive Check HTTP Server Status
MetadataApi isReady GET /health/ready Check HTTP Server and Database Status
V0alpha2Api adminCreateIdentity POST /admin/identities Create an Identity
V0alpha2Api adminCreateSelfServiceRecoveryLink POST /admin/recovery/link Create a Recovery Link
V0alpha2Api adminDeleteIdentity DELETE /admin/identities/{id} Delete an Identity
V0alpha2Api adminDeleteIdentitySessions DELETE /admin/identities/{id}/sessions Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2Api adminGetIdentity GET /admin/identities/{id} Get an Identity
V0alpha2Api adminListIdentities GET /admin/identities List Identities
V0alpha2Api adminListIdentitySessions GET /admin/identities/{id}/sessions This endpoint returns all sessions that belong to the given Identity.
V0alpha2Api adminUpdateIdentity PUT /admin/identities/{id} Update an Identity
V0alpha2Api createSelfServiceLogoutFlowUrlForBrowsers GET /self-service/logout/browser Create a Logout URL for Browsers
V0alpha2Api getJsonSchema GET /schemas/{id}
V0alpha2Api getSelfServiceError GET /self-service/errors Get Self-Service Errors
V0alpha2Api getSelfServiceLoginFlow GET /self-service/login/flows Get Login Flow
V0alpha2Api getSelfServiceRecoveryFlow GET /self-service/recovery/flows Get Recovery Flow
V0alpha2Api getSelfServiceRegistrationFlow GET /self-service/registration/flows Get Registration Flow
V0alpha2Api getSelfServiceSettingsFlow GET /self-service/settings/flows Get Settings Flow
V0alpha2Api getSelfServiceVerificationFlow GET /self-service/verification/flows Get Verification Flow
V0alpha2Api getWebAuthnJavaScript GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
V0alpha2Api initializeSelfServiceLoginFlowForBrowsers GET /self-service/login/browser Initialize Login Flow for Browsers
V0alpha2Api initializeSelfServiceLoginFlowWithoutBrowser GET /self-service/login/api Initialize Login Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceRecoveryFlowForBrowsers GET /self-service/recovery/browser Initialize Recovery Flow for Browsers
V0alpha2Api initializeSelfServiceRecoveryFlowWithoutBrowser GET /self-service/recovery/api Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceRegistrationFlowForBrowsers GET /self-service/registration/browser Initialize Registration Flow for Browsers
V0alpha2Api initializeSelfServiceRegistrationFlowWithoutBrowser GET /self-service/registration/api Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceSettingsFlowForBrowsers GET /self-service/settings/browser Initialize Settings Flow for Browsers
V0alpha2Api initializeSelfServiceSettingsFlowWithoutBrowser GET /self-service/settings/api Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha2Api initializeSelfServiceVerificationFlowForBrowsers GET /self-service/verification/browser Initialize Verification Flow for Browser Clients
V0alpha2Api initializeSelfServiceVerificationFlowWithoutBrowser GET /self-service/verification/api Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha2Api listIdentitySchemas GET /schemas
V0alpha2Api listSessions GET /sessions This 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.
V0alpha2Api revokeSession DELETE /sessions/{id} Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
V0alpha2Api revokeSessions DELETE /sessions Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
V0alpha2Api submitSelfServiceLoginFlow POST /self-service/login Submit a Login Flow
V0alpha2Api submitSelfServiceLogoutFlow GET /self-service/logout Complete Self-Service Logout
V0alpha2Api submitSelfServiceLogoutFlowWithoutBrowser DELETE /self-service/logout/api Perform Logout for APIs, Services, Apps, ...
V0alpha2Api submitSelfServiceRecoveryFlow POST /self-service/recovery Complete Recovery Flow
V0alpha2Api submitSelfServiceRegistrationFlow POST /self-service/registration Submit a Registration Flow
V0alpha2Api submitSelfServiceSettingsFlow POST /self-service/settings Complete Settings Flow
V0alpha2Api submitSelfServiceVerificationFlow POST /self-service/verification Complete Verification Flow
V0alpha2Api toSession GET /sessions/whoami Check 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

← Metadata

7
likes
0
pub points
71%
popularity

Publisher

verified publisherory.sh

Metadata

OpenAPI API client

Homepage

License

unknown (LICENSE)

Dependencies

built_collection, built_value, dio

More

Packages that depend on ory_kratos_client

Back