Ory Identities API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mjimlittle from gravatar.com mjimlittle

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

ory-kratos-client-async

This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more.

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

  • API version: v25.4.0
  • Package version: v25.4.0
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ory/sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ory/sdk.git)

Then import the package:

import ory_kratos_client_async

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ory_kratos_client_async

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ory_kratos_client_async
from ory_kratos_client_async.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ory_kratos_client_async.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: oryAccessToken
configuration.api_key['oryAccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['oryAccessToken'] = 'Bearer'


# Enter a context with an instance of the API client
async with ory_kratos_client_async.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ory_kratos_client_async.CourierApi(api_client)
    id = 'id_example' # str | MessageID is the ID of the message.

    try:
        # Get a Message
        api_response = await api_instance.get_courier_message(id)
        print("The response of CourierApi->get_courier_message:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CourierApi->get_courier_message: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
CourierApi get_courier_message GET /admin/courier/messages/{id} Get a Message
CourierApi list_courier_messages GET /admin/courier/messages List Messages
FrontendApi create_browser_login_flow GET /self-service/login/browser Create Login Flow for Browsers
FrontendApi create_browser_logout_flow GET /self-service/logout/browser Create a Logout URL for Browsers
FrontendApi create_browser_recovery_flow GET /self-service/recovery/browser Create Recovery Flow for Browsers
FrontendApi create_browser_registration_flow GET /self-service/registration/browser Create Registration Flow for Browsers
FrontendApi create_browser_settings_flow GET /self-service/settings/browser Create Settings Flow for Browsers
FrontendApi create_browser_verification_flow GET /self-service/verification/browser Create Verification Flow for Browser Clients
FrontendApi create_fedcm_flow GET /self-service/fed-cm/parameters Get FedCM Parameters
FrontendApi create_native_login_flow GET /self-service/login/api Create Login Flow for Native Apps
FrontendApi create_native_recovery_flow GET /self-service/recovery/api Create Recovery Flow for Native Apps
FrontendApi create_native_registration_flow GET /self-service/registration/api Create Registration Flow for Native Apps
FrontendApi create_native_settings_flow GET /self-service/settings/api Create Settings Flow for Native Apps
FrontendApi create_native_verification_flow GET /self-service/verification/api Create Verification Flow for Native Apps
FrontendApi disable_my_other_sessions DELETE /sessions Disable my other sessions
FrontendApi disable_my_session DELETE /sessions/{id} Disable one of my sessions
FrontendApi exchange_session_token GET /sessions/token-exchange Exchange Session Token
FrontendApi get_flow_error GET /self-service/errors Get User-Flow Errors
FrontendApi get_login_flow GET /self-service/login/flows Get Login Flow
FrontendApi get_recovery_flow GET /self-service/recovery/flows Get Recovery Flow
FrontendApi get_registration_flow GET /self-service/registration/flows Get Registration Flow
FrontendApi get_settings_flow GET /self-service/settings/flows Get Settings Flow
FrontendApi get_verification_flow GET /self-service/verification/flows Get Verification Flow
FrontendApi get_web_authn_java_script GET /.well-known/ory/webauthn.js Get WebAuthn JavaScript
FrontendApi list_my_sessions GET /sessions Get My Active Sessions
FrontendApi perform_native_logout DELETE /self-service/logout/api Perform Logout for Native Apps
FrontendApi to_session GET /sessions/whoami Check Who the Current HTTP Session Belongs To
FrontendApi update_fedcm_flow POST /self-service/fed-cm/token Submit a FedCM token
FrontendApi update_login_flow POST /self-service/login Submit a Login Flow
FrontendApi update_logout_flow GET /self-service/logout Update Logout Flow
FrontendApi update_recovery_flow POST /self-service/recovery Update Recovery Flow
FrontendApi update_registration_flow POST /self-service/registration Update Registration Flow
FrontendApi update_settings_flow POST /self-service/settings Complete Settings Flow
FrontendApi update_verification_flow POST /self-service/verification Complete Verification Flow
IdentityApi batch_patch_identities PATCH /admin/identities Create multiple identities
IdentityApi create_identity POST /admin/identities Create an Identity
IdentityApi create_recovery_code_for_identity POST /admin/recovery/code Create a Recovery Code
IdentityApi create_recovery_link_for_identity POST /admin/recovery/link Create a Recovery Link
IdentityApi delete_identity DELETE /admin/identities/{id} Delete an Identity
IdentityApi delete_identity_credentials DELETE /admin/identities/{id}/credentials/{type} Delete a credential for a specific identity
IdentityApi delete_identity_sessions DELETE /admin/identities/{id}/sessions Delete & Invalidate an Identity's Sessions
IdentityApi disable_session DELETE /admin/sessions/{id} Deactivate a Session
IdentityApi extend_session PATCH /admin/sessions/{id}/extend Extend a Session
IdentityApi get_identity GET /admin/identities/{id} Get an Identity
IdentityApi get_identity_by_external_id GET /admin/identities/by/external/{externalID} Get an Identity by its External ID
IdentityApi get_identity_schema GET /schemas/{id} Get Identity JSON Schema
IdentityApi get_session GET /admin/sessions/{id} Get Session
IdentityApi list_identities GET /admin/identities List Identities
IdentityApi list_identity_schemas GET /schemas Get all Identity Schemas
IdentityApi list_identity_sessions GET /admin/identities/{id}/sessions List an Identity's Sessions
IdentityApi list_sessions GET /admin/sessions List All Sessions
IdentityApi patch_identity PATCH /admin/identities/{id} Patch an Identity
IdentityApi update_identity PUT /admin/identities/{id} Update an Identity
MetadataApi get_version GET /version Return Running Software Version.
MetadataApi is_alive GET /health/alive Check HTTP Server Status
MetadataApi is_ready GET /health/ready Check HTTP Server and Database Status

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oryAccessToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

office@ory.sh

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mjimlittle from gravatar.com mjimlittle

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

This version

25.4.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exp_ory_kratos_client_async-25.4.0-py3-none-any.whl (318.3 kB view details)

Uploaded Python 3

File details

Details for the file exp_ory_kratos_client_async-25.4.0-py3-none-any.whl.

File metadata

  • Download URL: exp_ory_kratos_client_async-25.4.0-py3-none-any.whl
  • Upload date:
  • Size: 318.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"43","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for exp_ory_kratos_client_async-25.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c76cf76eed47a316a74acb7b76be10c2aef962a0079dc0c7a629c3920be3e9e
MD5 aa3ae953265b3591b71978021744b6c9
BLAKE2b-256 648ed2e07f48f32efea3d8980defdb5205c3bb220de0b9d5dec4b78b6e5c21c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page