#client #sdk #api-client #documentation #api #public

ory-client

SDK Client for Ory

45 releases

new 0.0.1-alpha.58 Jan 21, 2022
0.0.1-alpha.56 Jan 20, 2022
0.0.1-alpha.31 Dec 14, 2021
0.0.1-alpha.30 Nov 29, 2021
0.0.1-alpha.9 May 21, 2021
Download history 2/week @ 2021-10-02 16/week @ 2021-10-09 15/week @ 2021-11-06 14/week @ 2021-11-13 78/week @ 2021-11-20 22/week @ 2021-11-27 43/week @ 2021-12-04 26/week @ 2021-12-11 1/week @ 2021-12-25 111/week @ 2022-01-01 92/week @ 2022-01-08 178/week @ 2022-01-15

382 downloads per month

Apache-2.0

320KB
4K SLoC

Rust API client for ory-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.58
  • Package version: v0.0.1-alpha.58
  • 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
MetadataApi get_version GET /api/kratos/public/version Return Running Software Version.
MetadataApi is_alive GET /api/kratos/public/health/alive Check HTTP Server Status
MetadataApi is_ready GET /api/kratos/public/health/ready Check HTTP Server and Database Status
V0alpha0Api create_project POST /backoffice/public/projects Create a Project
V0alpha0Api get_project GET /backoffice/public/projects/{project_id} Get a Project
V0alpha0Api list_projects GET /backoffice/public/projects List All Projects
V0alpha0Api update_project PUT /backoffice/public/projects/{project_id} Update a Project
V0alpha2Api admin_create_identity POST /api/kratos/admin/identities Create an Identity
V0alpha2Api admin_create_self_service_recovery_link POST /api/kratos/admin/recovery/link Create a Recovery Link
V0alpha2Api admin_delete_identity DELETE /api/kratos/admin/identities/{id} Delete an Identity
V0alpha2Api admin_delete_identity_sessions DELETE /api/kratos/admin/identities/{id}/sessions Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2Api admin_get_identity GET /api/kratos/admin/identities/{id} Get an Identity
V0alpha2Api admin_list_identities GET /api/kratos/admin/identities List Identities
V0alpha2Api admin_list_identity_sessions GET /api/kratos/admin/identities/{id}/sessions This endpoint returns all sessions that belong to the given Identity.
V0alpha2Api admin_update_identity PUT /api/kratos/admin/identities/{id} Update an Identity
V0alpha2Api create_self_service_logout_flow_url_for_browsers GET /api/kratos/public/self-service/logout/browser Create a Logout URL for Browsers
V0alpha2Api get_json_schema GET /api/kratos/public/schemas/{id}
V0alpha2Api get_self_service_error GET /api/kratos/public/self-service/errors Get Self-Service Errors
V0alpha2Api get_self_service_login_flow GET /api/kratos/public/self-service/login/flows Get Login Flow
V0alpha2Api get_self_service_recovery_flow GET /api/kratos/public/self-service/recovery/flows Get Recovery Flow
V0alpha2Api get_self_service_registration_flow GET /api/kratos/public/self-service/registration/flows Get Registration Flow
V0alpha2Api get_self_service_settings_flow GET /api/kratos/public/self-service/settings/flows Get Settings Flow
V0alpha2Api get_self_service_verification_flow GET /api/kratos/public/self-service/verification/flows Get Verification Flow
V0alpha2Api get_web_authn_java_script GET /api/kratos/public/.well-known/ory/webauthn.js Get WebAuthn JavaScript
V0alpha2Api initialize_self_service_login_flow_for_browsers GET /api/kratos/public/self-service/login/browser Initialize Login Flow for Browsers
V0alpha2Api initialize_self_service_login_flow_without_browser GET /api/kratos/public/self-service/login/api Initialize Login Flow for APIs, Services, Apps, ...
V0alpha2Api initialize_self_service_recovery_flow_for_browsers GET /api/kratos/public/self-service/recovery/browser Initialize Recovery Flow for Browsers
V0alpha2Api initialize_self_service_recovery_flow_without_browser GET /api/kratos/public/self-service/recovery/api Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2Api initialize_self_service_registration_flow_for_browsers GET /api/kratos/public/self-service/registration/browser Initialize Registration Flow for Browsers
V0alpha2Api initialize_self_service_registration_flow_without_browser GET /api/kratos/public/self-service/registration/api Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha2Api initialize_self_service_settings_flow_for_browsers GET /api/kratos/public/self-service/settings/browser Initialize Settings Flow for Browsers
V0alpha2Api initialize_self_service_settings_flow_without_browser GET /api/kratos/public/self-service/settings/api Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha2Api initialize_self_service_verification_flow_for_browsers GET /api/kratos/public/self-service/verification/browser Initialize Verification Flow for Browser Clients
V0alpha2Api initialize_self_service_verification_flow_without_browser GET /api/kratos/public/self-service/verification/api Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha2Api list_identity_schemas GET /api/kratos/public/schemas
V0alpha2Api list_sessions GET /api/kratos/public/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 revoke_session DELETE /api/kratos/public/sessions/{id} Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
V0alpha2Api revoke_sessions DELETE /api/kratos/public/sessions Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
V0alpha2Api submit_self_service_login_flow POST /api/kratos/public/self-service/login Submit a Login Flow
V0alpha2Api submit_self_service_logout_flow GET /api/kratos/public/self-service/logout Complete Self-Service Logout
V0alpha2Api submit_self_service_logout_flow_without_browser DELETE /api/kratos/public/self-service/logout/api Perform Logout for APIs, Services, Apps, ...
V0alpha2Api submit_self_service_recovery_flow POST /api/kratos/public/self-service/recovery Complete Recovery Flow
V0alpha2Api submit_self_service_registration_flow POST /api/kratos/public/self-service/registration Submit a Registration Flow
V0alpha2Api submit_self_service_settings_flow POST /api/kratos/public/self-service/settings Complete Settings Flow
V0alpha2Api submit_self_service_verification_flow POST /api/kratos/public/self-service/verification Complete Verification Flow
V0alpha2Api to_session GET /api/kratos/public/sessions/whoami Check Who the Current HTTP Session Belongs To

Documentation For Models

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

cargo doc --open

Author

support@ory.sh

Dependencies

~3–7MB
~170K SLoC

a