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 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.
Put the package under your project folder and add the following to Cargo.toml
under [dependencies]
:
openapi = { path = "./generated" }
All URIs are relative to https://playground.projects.oryapis.com
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
MetadataApi | getversion | GET /api/kratos/public/version | Return Running Software Version.
*MetadataApi* | isalive | GET /api/kratos/public/health/alive | Check HTTP Server Status
MetadataApi | isready | GET /api/kratos/public/health/ready | Check HTTP Server and Database Status
*V0alpha0Api* | createproject | POST /backoffice/public/projects | Create a Project
V0alpha0Api | getactiveproject | GET /backoffice/public/console/projects/active | Returns Your Active Ory Cloud Project
V0alpha0Api | getproject | GET /backoffice/public/projects/{projectid} | Get a Project
V0alpha0Api | getprojectmembers | GET /backoffice/public/projects/{projectid}/members | Get all members associated with this project.
*V0alpha0Api* | listprojects | GET /backoffice/public/projects | List All Projects
V0alpha0Api | purgeproject | DELETE /backoffice/public/projects/{projectid} | Irrecoverably Purge a Project
V0alpha0Api | removeprojectmember | DELETE /backoffice/public/projects/{projectid}/members/{memberid} | Remove a member associated with this project. This also sets their invite status to REMOVED
.
V0alpha0Api | setactiveproject | PUT /backoffice/public/console/projects/active | Sets Your Active Project
V0alpha0Api | updateproject | PUT /backoffice/public/projects/{projectid} | Update a Project
V0alpha0Api | updateprojectconfig | PUT /backoffice/public/projects/{projectid}/configs | Update an Ory Cloud Project Configuration
*V0alpha2Api* | admincreateidentity | POST /api/kratos/admin/identities | Create an Identity
*V0alpha2Api* | admincreateselfservicerecoverylink | POST /api/kratos/admin/recovery/link | Create a Recovery Link
V0alpha2Api | admindeleteidentity | DELETE /api/kratos/admin/identities/{id} | Delete an Identity
V0alpha2Api | admindeleteidentitysessions | 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* | admingetidentity | GET /api/kratos/admin/identities/{id} | Get an Identity
*V0alpha2Api* | adminlistidentities | GET /api/kratos/admin/identities | List Identities
*V0alpha2Api* | adminlistidentitysessions | GET /api/kratos/admin/identities/{id}/sessions | This endpoint returns all sessions that belong to the given Identity.
V0alpha2Api | adminupdateidentity | PUT /api/kratos/admin/identities/{id} | Update an Identity
V0alpha2Api | createselfservicelogoutflowurlforbrowsers | GET /api/kratos/public/self-service/logout/browser | Create a Logout URL for Browsers
*V0alpha2Api* | getjsonschema | GET /api/kratos/public/schemas/{id} |
*V0alpha2Api* | getselfserviceerror | GET /api/kratos/public/self-service/errors | Get Self-Service Errors
V0alpha2Api | getselfserviceloginflow | GET /api/kratos/public/self-service/login/flows | Get Login Flow
V0alpha2Api | getselfservicerecoveryflow | GET /api/kratos/public/self-service/recovery/flows | Get Recovery Flow
V0alpha2Api | getselfserviceregistrationflow | GET /api/kratos/public/self-service/registration/flows | Get Registration Flow
V0alpha2Api | getselfservicesettingsflow | GET /api/kratos/public/self-service/settings/flows | Get Settings Flow
V0alpha2Api | getselfserviceverificationflow | GET /api/kratos/public/self-service/verification/flows | Get Verification Flow
V0alpha2Api | getwebauthnjavascript | GET /api/kratos/public/.well-known/ory/webauthn.js | Get WebAuthn JavaScript
V0alpha2Api | initializeselfserviceloginflowforbrowsers | GET /api/kratos/public/self-service/login/browser | Initialize Login Flow for Browsers
V0alpha2Api | initializeselfserviceloginflowwithoutbrowser | GET /api/kratos/public/self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ...
V0alpha2Api | initializeselfservicerecoveryflowforbrowsers | GET /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browsers
V0alpha2Api | initializeselfservicerecoveryflowwithoutbrowser | GET /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2Api | initializeselfserviceregistrationflowforbrowsers | GET /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for Browsers
V0alpha2Api | initializeselfserviceregistrationflowwithoutbrowser | GET /api/kratos/public/self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ...
V0alpha2Api | initializeselfservicesettingsflowforbrowsers | GET /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers
V0alpha2Api | initializeselfservicesettingsflowwithoutbrowser | GET /api/kratos/public/self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ...
V0alpha2Api | initializeselfserviceverificationflowforbrowsers | GET /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients
V0alpha2Api | initializeselfserviceverificationflowwithoutbrowser | GET /api/kratos/public/self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ...
V0alpha2Api | listidentityschemas | GET /api/kratos/public/schemas |
V0alpha2Api | listsessions | 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* | revokesession | 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 | revokesessions | 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* | submitselfserviceloginflow | POST /api/kratos/public/self-service/login | Submit a Login Flow
*V0alpha2Api* | submitselfservicelogoutflow | GET /api/kratos/public/self-service/logout | Complete Self-Service Logout
*V0alpha2Api* | submitselfservicelogoutflowwithoutbrowser | DELETE /api/kratos/public/self-service/logout/api | Perform Logout for APIs, Services, Apps, ...
*V0alpha2Api* | submitselfservicerecoveryflow | POST /api/kratos/public/self-service/recovery | Complete Recovery Flow
*V0alpha2Api* | submitselfserviceregistrationflow | POST /api/kratos/public/self-service/registration | Submit a Registration Flow
*V0alpha2Api* | submitselfservicesettingsflow | POST /api/kratos/public/self-service/settings | Complete Settings Flow
*V0alpha2Api* | submitselfserviceverificationflow | POST /api/kratos/public/self-service/verification | Complete Verification Flow
*V0alpha2Api* | tosession | GET /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To
To get access to the crate's generated documentation, use:
cargo doc --open
support@ory.sh