New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

Ory Network SDK Reference

The Ory SDKs integrate your application with Ory services, including Ory Identities, Ory Permissions, and Ory OAuth2. Each SDK is generated from the same OpenAPI description as this reference, so types and method signatures stay in sync with the API.

Select your language on the right, then search or browse the operations below. Each operation shows a request example in the language you select.

These SDKs are for Ory Network. Self-hosted deployments use service-specific tools instead — see the reference documentation for Ory Enterprise License or Ory Open Source.

Client Libraries
npm install @ory/client

Further information​

The SDKs are generated with openapi-generator, which can change the code it produces between versions. As a result, a new SDK release may not be backwards compatible with the previous one.

identity

List Identities API reference
Create multiple identities API reference
Create an Identity API reference
Get an Identity by its External ID API reference
Delete an Identity API reference
Get an Identity API reference
Patch an Identity API reference
Update an Identity API reference
Delete a credential for a specific identity API reference
Delete & Invalidate an Identity's Sessions API reference
List an Identity's Sessions API reference
Create a Recovery Code API reference
Create a Recovery Link API reference
List All Sessions API reference
Manage sessions in bulk API reference
Deactivate a Session API reference
Get Session API reference
Extend a Session API reference
Create a test OIDC login flow API reference
Get all Identity Schemas API reference
Get Identity JSON Schema API reference

frontend

Get WebAuthn JavaScript API reference
Get User-Flow Errors API reference
Get FedCM Parameters API reference
Submit a FedCM token API reference
Submit a Login Flow API reference
Create Login Flow for Native Apps API reference
Create Login Flow for Browsers API reference
Get Login Flow API reference
Delete a test OIDC login flow API reference
Update Logout Flow API reference
Perform Logout for Native Apps API reference
Create a Logout URL for Browsers API reference
Update Recovery Flow API reference
Create Recovery Flow for Native Apps API reference
Create Recovery Flow for Browsers API reference
Get Recovery Flow API reference
Update Registration Flow API reference
Create Registration Flow for Native Apps API reference
Create Registration Flow for Browsers API reference
Get Registration Flow API reference
Complete Settings Flow API reference
Create Settings Flow for Native Apps API reference
Create Settings Flow for Browsers API reference
Get Settings Flow API reference
Complete Verification Flow API reference
Create Verification Flow for Native Apps API reference
Create Verification Flow for Browser Clients API reference
Get Verification Flow API reference
Disable my other sessions API reference
Get My Active Sessions API reference
Exchange Session Token API reference
Check Who the Current HTTP Session Belongs To API reference
Disable one of my sessions API reference

courier

List Messages API reference
Get a Message API reference

metadata

Return Running Software Version. API reference

wellknown

Discover Well-Known JSON Web Keys API reference

oidc

OpenID Connect Discovery API reference
Issues a Verifiable Credential API reference
Register OAuth2 Client using OpenID Dynamic Client Registration API reference
Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol API reference
Get OAuth2 Client using OpenID Dynamic Client Registration API reference
Set OAuth2 Client using OpenID Dynamic Client Registration API reference
OpenID Connect Front- and Back-channel Enabled Logout API reference
OpenID Connect Userinfo API reference

oAuth2

List OAuth 2.0 Clients API reference
Create OAuth 2.0 Client API reference
Delete OAuth 2.0 Client API reference
Get an OAuth 2.0 Client API reference
Patch OAuth 2.0 Client API reference
Set OAuth 2.0 Client API reference
Set OAuth2 Client Token Lifespans API reference
Get OAuth 2.0 Consent Request API reference
Accept OAuth 2.0 Consent Request API reference
Reject OAuth 2.0 Consent Request API reference
Accepts a device grant user_code request API reference
Get OAuth 2.0 Login Request API reference
Accept OAuth 2.0 Login Request API reference
Reject OAuth 2.0 Login Request API reference
Get OAuth 2.0 Session Logout Request API reference
Accept OAuth 2.0 Session Logout Request API reference
Reject OAuth 2.0 Session Logout Request API reference
Revoke OAuth 2.0 Consent Sessions of a Subject API reference
List OAuth 2.0 Consent Sessions of a Subject API reference
Revokes OAuth 2.0 Login Sessions by either a Subject or a SessionID API reference
Introspect OAuth2 Access and Refresh Tokens API reference
Delete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client API reference
List Trusted OAuth2 JWT Bearer Grant Type Issuers API reference
Trust OAuth2 JWT Bearer Grant Type Issuer API reference
Delete Trusted OAuth2 JWT Bearer Grant Type Issuer API reference
Get Trusted OAuth2 JWT Bearer Grant Type Issuer API reference
OAuth 2.0 Authorize Endpoint API reference
The OAuth 2.0 Device Authorize Endpoint API reference
OAuth 2.0 Device Verification Endpoint API reference
Revoke OAuth 2.0 Access or Refresh Token API reference
The OAuth 2.0 Token Endpoint API reference

jwk

Delete JSON Web Key Set API reference
Retrieve a JSON Web Key Set API reference
Create JSON Web Key API reference
Update a JSON Web Key Set API reference
Delete JSON Web Key API reference
Get JSON Web Key API reference
Set JSON Web Key API reference

relationship

Delete Relationships API reference
Patch Multiple Relationships API reference
Create a Relationship API reference
Query namespaces API reference
Check the syntax of an OPL file API reference
Query relationships API reference

project

List All Projects API reference
Create a Project API reference
Irrecoverably purge a project API reference
Get a Project API reference
Patch an Ory Network Project Configuration API reference
Update an Ory Network Project Configuration API reference
List all Enterprise SSO organizations API reference
Create an Enterprise SSO Organization API reference
Delete Enterprise SSO Organization API reference
Get Enterprise SSO Organization by ID API reference
Update an Enterprise SSO Organization API reference
Get the organization onboarding portal links API reference
Create organization onboarding portal link API reference
Delete an organization onboarding portal link API reference
Update organization onboarding portal link API reference
Patch an Ory Network Project Configuration based on a revision ID API reference
Get all members associated with this project API reference
Remove a member associated with this project API reference
List a project's API keys API reference
Create project API key API reference
Delete project API key API reference

events

List all event streams for the project. This endpoint is not paginated. API reference
Create an event stream for your project. API reference
Remove an event stream from a project API reference
Update an event stream for a project. API reference

permission

Batch check permissions API reference
Check a permission API reference
Check a permission API reference
Check a permission API reference
Check a permission API reference
Expand a Relationship into permissions. API reference

workspace

List workspaces the user is a member of API reference
Create a new workspace API reference
Get a workspace API reference
Update an workspace API reference
List all projects of a workspace API reference
List a workspace's API keys API reference
Create workspace API key API reference
Delete workspace API key API reference
List workspace contacts API reference
Create a workspace contact API reference
Patch a workspace contact API reference
Delete a workspace contact API reference