#flow #api-client #server #remote #generate #api #recovery #admin

ory-client-client

SDK Client for ORY Keto

1 unstable release

0.0.1-alpha.1 May 18, 2021

#1969 in Web programming

Apache-2.0

225KB
3K SLoC

Rust API client for 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.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v0.0.1-alpha.1
  • Package version: v0.0.1-alpha.1
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder and add the following to Cargo.toml under [dependencies]:

    openapi = { path = "./generated" }

Documentation for API Endpoints

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

Class Method HTTP request Description
DefaultApi create_identity_admin post /api/kratos/admin/identities Create an Identity
DefaultApi create_recovery_link_admin post /api/kratos/admin/recovery/link Create a Recovery Link
DefaultApi delete_identity_admin delete /api/kratos/admin/identities/{id} Delete an Identity
DefaultApi get_identity_admin get /api/kratos/admin/identities/{id} Get an Identity
DefaultApi get_schema get /api/kratos/public/schemas/{id}
DefaultApi get_schema_admin get /api/kratos/admin/schemas/{id}
DefaultApi get_self_service_error get /api/kratos/public/self-service/errors Get User-Facing Self-Service Errors
DefaultApi get_self_service_error_admin get /api/kratos/admin/self-service/errors Get User-Facing Self-Service Errors
DefaultApi get_self_service_login_flow get /api/kratos/public/self-service/login/flows Get Login Flow
DefaultApi get_self_service_login_flow_admin get /api/kratos/admin/self-service/login/flows Get Login Flow
DefaultApi get_self_service_recovery_flow get /api/kratos/public/self-service/recovery/flows Get information about a recovery flow
DefaultApi get_self_service_recovery_flow_admin get /api/kratos/admin/self-service/recovery/flows Get information about a recovery flow
DefaultApi get_self_service_registration_flow get /api/kratos/public/self-service/registration/flows Get Registration Flow
DefaultApi get_self_service_registration_flow_admin get /api/kratos/admin/self-service/registration/flows Get Registration Flow
DefaultApi get_self_service_settings_flow get /api/kratos/public/self-service/settings/flows Get Settings Flow
DefaultApi get_self_service_settings_flow_admin get /api/kratos/admin/self-service/settings/flows Get Settings Flow
DefaultApi get_self_service_verification_flow get /api/kratos/public/self-service/verification/flows Get Verification Flow
DefaultApi get_self_service_verification_flow_admin get /api/kratos/admin/self-service/verification/flows Get Verification Flow
DefaultApi get_version_admin get /api/kratos/admin/version Return Running Software Version.
DefaultApi initialize_self_service_browser_logout_flow get /api/kratos/public/self-service/browser/flows/logout Initialize Browser-Based Logout User Flow
DefaultApi initialize_self_service_login_via_api_flow get /api/kratos/public/self-service/login/api Initialize Login Flow for API clients
DefaultApi initialize_self_service_login_via_browser_flow get /api/kratos/public/self-service/login/browser Initialize Login Flow for browsers
DefaultApi initialize_self_service_recovery_via_api_flow get /api/kratos/public/self-service/recovery/api Initialize Recovery Flow for API Clients
DefaultApi initialize_self_service_recovery_via_browser_flow get /api/kratos/public/self-service/recovery/browser Initialize Recovery Flow for Browser Clients
DefaultApi initialize_self_service_registration get /api/kratos/public/self-service/registration/api Initialize Registration Flow for API clients
DefaultApi initialize_self_service_registration_for_browsers get /api/kratos/public/self-service/registration/browser Initialize Registration Flow for browsers
DefaultApi initialize_self_service_settings_via_api_flow get /api/kratos/public/self-service/settings/api Initialize Settings Flow for API Clients
DefaultApi initialize_self_service_settings_via_browser_flow get /api/kratos/public/self-service/settings/browser Initialize Settings Flow for Browsers
DefaultApi initialize_self_service_verification_via_api_flow get /api/kratos/public/self-service/verification/api Initialize Verification Flow for API Clients
DefaultApi initialize_self_service_verification_via_browser_flow get /api/kratos/public/self-service/verification/browser Initialize Verification Flow for Browser Clients
DefaultApi is_alive_admin get /api/kratos/admin/health/alive Check HTTP Server Status
DefaultApi is_ready_admin get /api/kratos/admin/health/ready Check HTTP Server and Database Status
DefaultApi list_identities_admin get /api/kratos/admin/identities List Identities
DefaultApi prometheus_admin 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 revoke_session delete /api/kratos/public/sessions Initialize Logout Flow for API Clients - Revoke a Session
DefaultApi submit_self_service_login_flow post /api/kratos/public/self-service/login Submit a Login Flow
DefaultApi submit_self_service_recovery_flow post /api/kratos/public/self-service/recovery Complete Recovery Flow
DefaultApi submit_self_service_recovery_flow_with_link_method post /api/kratos/public/self-service/recovery/methods/link Complete Recovery Flow with Link Method
DefaultApi submit_self_service_registration_flow post /api/kratos/public/self-service/registration Submit a Registration Flow
DefaultApi submit_self_service_settings_flow post /api/kratos/public/self-service/settings Complete Settings Flow
DefaultApi submit_self_service_verification_flow post /api/kratos/public/self-service/verification/methods/link Complete Verification Flow
DefaultApi to_session get /api/kratos/public/sessions/whoami Check Who the Current HTTP Session Belongs To
DefaultApi update_identity_admin put /api/kratos/admin/identities/{id} Update an Identity

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

support@ory.sh

Dependencies

~4–17MB
~254K SLoC