How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Ory

Ory identity API

APIs for managing identities.

Documentation Provider Profile APIs.io OpenAPI GitHub

Ory identity API is one of 22 APIs that Ory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Identity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 19 operations across 12 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{project-slug}.projects.oryapis.com, https://api.console.ory.sh.

19 operations 12 paths 58 schemas 4 DELETE8 GET3 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://{project-slug}.projects.oryapis.com
https://api.console.ory.sh
Authentication
HTTP Basic, HTTP Bearer, OAuth 2.0
Contact
hi@ory.sh
License
Apache 2.0
Resource Areas
1

Authentication & Security 3

Ory identity API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It accepts HTTP bearer tokens (bearer). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 19

Across 12 paths, the API surfaces 19 operations — 4 DELETE, 8 GET, 3 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

identity 19

APIs for managing identities.

GET
/admin/identities
List Identities
listIdentities 10 params → 200default
PATCH
/admin/identities
Create multiple identities
batchPatchIdentities body → 200400409default
POST
/admin/identities
Create an Identity
createIdentity body → 201400409default
GET
/admin/identities/by/external/{externalID}
Get an Identity by its External ID
getIdentityByExternalID 2 params → 200404default
DELETE
/admin/identities/{id}
Delete an Identity
deleteIdentity 1 param → 204404default
GET
/admin/identities/{id}
Get an Identity
getIdentity 2 params → 200404default
PATCH
/admin/identities/{id}
Patch an Identity
patchIdentity 1 param body → 200400404409default
PUT
/admin/identities/{id}
Update an Identity
updateIdentity 1 param body → 200400404409default
DELETE
/admin/identities/{id}/credentials/{type}
Delete a credential for a specific identity
deleteIdentityCredentials 3 params → 204404default
DELETE
/admin/identities/{id}/sessions
Delete & Invalidate an Identity's Sessions
deleteIdentitySessions 1 param → 204400401404default
GET
/admin/identities/{id}/sessions
List an Identity's Sessions
listIdentitySessions 6 params → 200400404default
POST
/admin/recovery/code
Create a Recovery Code
createRecoveryCodeForIdentity body → 201400404default
POST
/admin/recovery/link
Create a Recovery Link
createRecoveryLinkForIdentity 1 param body → 200400404default
GET
/admin/sessions
List All Sessions
listSessions 4 params → 200400default
DELETE
/admin/sessions/{id}
Deactivate a Session
disableSession 1 param → 204400401default
GET
/admin/sessions/{id}
Get Session
getSession 2 params → 200400default
PATCH
/admin/sessions/{id}/extend
Extend a Session
extendSession 1 param → 200204400404default
GET
/schemas
Get all Identity Schemas
listIdentitySchemas 4 params → 200default
GET
/schemas/{id}
Get Identity JSON Schema
getIdentitySchema 1 param → 200404default

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are identity (15 properties), createIdentityBody (10 properties), session (10 properties), identityCredentialsWebAuthn (10 properties). Each schema is shown below with its type and property counts.

identityWithCredentialsPasskey
object
Create Identity and Import Passkey Credentials
1 property
errorGeneric
object
The standard Ory JSON API error format.
1 property 1 required
sessionDevice
object
Device corresponding to a Session
4 properties 1 required
identitySchema
object
Raw JSON Schema
identityCredentialsWebAuthnAuthenticator
object
3 properties
JSONRawMessage
object
nullTime
string
authenticatorAssuranceLevel
string
The authenticator assurance level can be one of "aal1", "aal2", or "aal3". A higher number means that it is harder for an attacker to compromise the account. G…
sessionAuthenticationMethods
array
A list of authenticators which were used to authenticate the session.
identityWithCredentialsSamlConfigProvider
object
Payload of specific SAML provider
3 properties 2 required
createRecoveryLinkForIdentityBody
object
Create Recovery Link for Identity Request Body
2 properties 1 required
session
object
A Session
10 properties 1 required
identityWithCredentialsTotpConfig
object
Create Identity and Import TOTP 2FA Credentials Configuration
1 property
identitySchemas
array
List of Identity JSON Schemas
createRecoveryCodeForIdentityBody
object
Create Recovery Code for Identity Request Body
3 properties 1 required
selfServiceFlowType
string
The flow type can either be api or browser.
identityCredentials
object
Credentials represents a specific credential type
6 properties
identityCredentialsWebAuthnAttestation
object
5 properties
identity
object
An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.
15 properties 4 required
identityWithCredentialsSaml
object
Payload to import SAML credentials
1 property
identityCredentialsWebAuthnFlags
object
4 properties
identityPatch
object
Payload for patching an identity
2 properties
identityWithCredentials
object
Create Identity and Import Credentials
7 properties
identityVerifiableAddressStatus
string
VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema
identityWithCredentialsTotp
object
Create Identity and Import TOTP 2FA Credentials
1 property
nullJsonRawMessage
NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
DefaultError
From https://go.dev/wiki/CodeReviewCommentsreceiver-type: Can function or methods, either concurrently or when called from this method, be mutating the receive…
updateIdentityBody
object
Update Identity Body
7 properties 3 required
batchPatchIdentitiesResponse
object
Patch identities response
1 property
recoveryIdentityAddress
object
6 properties 2 required
identityPatchResponse
object
Response for a single identity patch
4 properties
AdminIdentityImportCredentialsLookupSecretConfig
object
Create Identity and Import Lookup Secret Credentials Configuration
1 property
identityWithCredentialsWebAuthn
object
Create Identity and Import WebAuthn Credentials
1 property
identityCredentialsLookupSecretCode
object
Recovery codes can be used once and are invalidated after use.
2 properties
createIdentityBody
object
Create Identity Body
10 properties 2 required
identityWithCredentialsSamlConfig
object
Payload of SAML providers
1 property
identitySchemaContainer
object
An Identity JSON Schema Container
2 properties 2 required
identityWithCredentialsPassword
object
Create Identity and Import Password Credentials
1 property
patchIdentitiesBody
object
Patch Identities Body
1 property
jsonPatch
object
A JSONPatch document as defined by RFC 6902
4 properties 2 required
NullUUID
stringnull
identityCredentialsWebAuthn
object
10 properties
recoveryLinkForIdentity
object
Used when an administrator creates a recovery link for an identity.
2 properties 1 required
identityWithCredentialsOidcConfig
object
1 property
identityWithCredentialsWebAuthnConfig
object
Create Identity and Import WebAuthn Credentials Configuration
2 properties
identityWithCredentialsPasskeyConfig
object
Create Identity and Import Passkey Credentials Configuration
2 properties
identityWithCredentialsOidcConfigProvider
object
Create Identity and Import Social Sign In Credentials Configuration
4 properties 2 required
recoveryCodeForIdentity
object
Used when an administrator creates a recovery code for an identity.
3 properties 2 required
verifiableIdentityAddress
object
VerifiableAddress is an identity's verifiable address
8 properties 4 required
identityWithCredentialsOidc
object
Create Identity and Import Social Sign In Credentials
1 property
jsonPatchDocument
array
A JSONPatchDocument request
identityTraits
Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated a…
identityCredentialsWebAuthnList
array
identityWithCredentialsPasswordConfig
object
Create Identity and Import Password Credentials Configuration
3 properties
AdminIdentityImportCredentialsLookupSecret
object
Create Identity and Import Lookup Secret Credentials
1 property
sessionAuthenticationMethod
object
A singular authenticator used during authentication / login.
7 properties
genericError
object
8 properties 1 required
AuthenticatorTransport
string
Authenticators may implement various transports for communicating with clients. This enumeration defines hints as to how clients might communicate with a parti…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ory-identity-api-openapi.yml Raw ↑

Other APIs Ory publishes across the network.

Ory api API
AE Profile APIs.io
Ory courier API
AE Profile APIs.io
Ory frontend API
AE Profile APIs.io
Ory jwk API
AE Profile APIs.io
Ory metadata API
AE Profile APIs.io
Ory oAuth2 API
AE Profile APIs.io
Ory oidc API
AE Profile APIs.io
Ory permission API
AE Profile APIs.io
Ory relationship API
AE Profile APIs.io
Ory wellknown API
AE Profile APIs.io
Ory Billing API
AE Profile APIs.io
Ory Event Streams API
AE Profile APIs.io
#Identity
← Back to O APIs
API Details
ID
ory:ory-identity-api
Server
https://{project-slug}.projects.oryapis.com
Docs
https://www.ory.com/hydra/
Provider
Ory
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ory-identity-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ory-identity-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Ory identity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.