Ory APIs
Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Introduction
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.
SDKs
This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages:
Endpoints 179
identity
- GETList Identities
/admin/identities?per_page=250&page=0&page_size=250&page_token=string&consistency=&ids=string&credentials_identifier=string&preview_credentials_identifier_similar=string&include_credential=string&organization_id=stringLists all identities in the system. Note: filters cannot be combined. - POSTCreate an Identity
/admin/identitiesCreate an identity. This endpoint can also be used to import credentials for instance passwords, social sign in configurations, or multifactor methods. - PATCHCreate multiple identities
/admin/identitiesCreates multiple identities. You can also use this endpoint to import credentials, including passwords, social sign-in settings, and multi-factor… - GETGet an Identity by its External ID
/admin/identities/by/external/:externalID?include_credential=passwordReturn an identity by its external ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the… - GETGet an Identity
/admin/identities/:id?include_credential=passwordReturn an identity by its ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the include_credential query… - PUTUpdate an Identity
/admin/identities/:idThis endpoint updates an identity. The full identity payload (except credentials) is expected. It is possible to update the identity's credentials as well.… - DELETEDelete an Identity
/admin/identities/:idCalling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the… - PATCHPatch an Identity
/admin/identities/:idPartially updates an identity's field using JSON Patch. The fields id, stateChangedAt and credentials can not be updated using this method. - DELETEDelete a credential for a specific identity
/admin/identities/:id/credentials/:type?identifier=stringDelete an identity credential by its type. You cannot delete passkeys or code auth credentials through this API. - GETList an Identity's Sessions
/admin/identities/:id/sessions?per_page=250&page=0&page_size=250&page_token=string&active=trueThis endpoint returns all sessions that belong to the given Identity. - DELETEDelete & Invalidate an Identity's Sessions
/admin/identities/:id/sessionsCalling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. - POSTCreate a Recovery Code
/admin/recovery/codeThis endpoint creates a recovery code which should be given to the user in order for them to recover (or activate) their account. - POSTCreate a Recovery Link
/admin/recovery/link?return_to=stringThis endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account. - GETList All Sessions
/admin/sessions?page_size=250&page_token=string&active=true&expand=identityListing all sessions that exist. - POSTManage sessions in bulk
/admin/sessionsDisable or delete sessions for a list of identities or a list of sessions in a single call. The action field selects the operation: disable — deactivate… - GETGet Session
/admin/sessions/:id?expand=identityThis endpoint is useful for: Getting a session object with all specified expandables that exist in an administrative context. - DELETEDeactivate a Session
/admin/sessions/:idCalling this endpoint deactivates the specified session. Session data is not deleted. - PATCHExtend a Session
/admin/sessions/:id/extendCalling this endpoint extends the given session ID. If session.earliest_possible_extend is set it will only extend the session after the specified time has… - POSTCreate a test OIDC login flow
/admin/test-login-flowsCreates a dry-run OIDC test login flow pre-scoped to one provider. The returned flow carries a single-submit UI and a CSRF bearer token. No identity is… - GETGet all Identity Schemas
/schemas?per_page=250&page=0&page_size=250&page_token=stringReturns a list of all identity schemas currently in use. - GETGet Identity JSON Schema
/schemas/:idReturn a specific identity schema.
frontend
- GETChange Password URL
/.well-known/change-passwordThis endpoint implements the W3C "change password URL" well-known location by redirecting the browser to the configured settings UI. Password managers follow… - GETGet WebAuthn JavaScript
/.well-known/ory/webauthn.jsThis endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in… - GETGet WebAuthn Related Origins
/.well-known/webauthnThis endpoint serves the WebAuthn Related Origin Requests document specified in https://www.w3.org/TR/webauthn-3/#sctn-related-origins. It lists the web… - GETGet User-Flow Errors
/self-service/errors?id=stringThis endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI:… - GETGet FedCM Parameters
/self-service/fed-cm/parametersThis endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network. - POSTSubmit a FedCM token
/self-service/fed-cm/tokenUse this endpoint to submit a token from a FedCM provider through navigator.credentials.get and log the user in. The parameters from navigator.credentials.get… - POSTSubmit a Login Flow
/self-service/login?flow=stringUse this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect application/json to be sent in the… - GETCreate Login Flow for Native Apps
/self-service/login/api?refresh=true&aal=string&return_session_token_exchange_code=true&return_to=string&organization=string&via=string&identity_schema=stringThis endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session… - GETCreate Login Flow for Browsers
/self-service/login/browser?refresh=true&aal=string&return_to=string&login_challenge=string&organization=string&via=string&identity_schema=stringThis endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based… - GETGet Login Flow
/self-service/login/flows?id=stringThis endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included… - DELETEDelete a test OIDC login flow
/self-service/login/test?id=stringDeletes a dry-run OIDC test login flow. A flow whose debug payload has been captured requires the HMAC cookie set by the OIDC callback; a flow still in the… - GETUpdate Logout Flow
/self-service/logout?token=string&return_to=stringThis endpoint logs out an identity in a self-service manner. If the Accept HTTP header is not set to application/json, the browser will be redirected (HTTP… - DELETEPerform Logout for Native Apps
/self-service/logout/apiUse this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully revoked, the server returns a 204 No Content… - GETCreate a Logout URL for Browsers
/self-service/logout/browser?return_to=stringThis endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and… - POSTNative SAML Assertion Consumer Service (ACS)
/self-service/methods/saml/acs/:providerThis is the Assertion Consumer Service (ACS) for the native SAML engine. The identity provider delivers its SAML Response here via the HTTP-POST binding,… - GETComplete IdP-Initiated SAML Login for Browsers
/self-service/methods/saml/idp-initiated/:provider?code=stringThis endpoint is the entry point for IdP-initiated login through Ory Polis. Ory Polis redirects the browser here with a single-use authorization code after… - GETInitiate Native SAML Sign-In
/self-service/methods/saml/init/:provider?flow=string&purpose=loginThis endpoint starts a native SP-initiated SAML sign-in for the given connection. It checks that the flow named by the flow query parameter exists as the kind… - POSTInitiate Native SAML Sign-In (Direct POST)
/self-service/methods/saml/init/:provider?flow=string&purpose=loginIdentical to GET /self-service/methods/saml/init/{provider}, except the caller POSTs directly to this endpoint -- validated by the anti-CSRF middleware --… - GETGet SAML SP Metadata
/self-service/methods/saml/metadataThis endpoint serves the per-project SAML Service Provider metadata document: the SP entity ID and certificates this Ory Network project presents to every… - GETGet Per-Connection SAML SP Metadata
/self-service/methods/saml/metadata/:providerThis endpoint serves per-connection SAML Service Provider metadata: the identity and certificate a single native connection presents to its identity provider,… - POSTUpdate Recovery Flow
/self-service/recovery?flow=string&token=stringUse this endpoint to update a recovery flow. This endpoint behaves differently for API and browser flows and has several states: choose_method expects flow… - GETCreate Recovery Flow for Native Apps
/self-service/recovery/apiThis endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is… - GETCreate Recovery Flow for Browsers
/self-service/recovery/browser?return_to=string&skip_settings=stringThis endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to selfservice.flows.recovery.ui_url with… - GETGet Recovery Flow
/self-service/recovery/flows?id=stringThis endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be… - POSTUpdate Registration Flow
/self-service/registration?flow=stringUse this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows.… - GETCreate Registration Flow for Native Apps
/self-service/registration/api?return_session_token_exchange_code=true&return_to=string&organization=string&identity_schema=stringThis endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token… - GETCreate Registration Flow for Browsers
/self-service/registration/browser?return_to=string&login_challenge=string&after_verification_return_to=string&organization=string&identity_schema=stringThis endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for… - GETGet Registration Flow
/self-service/registration/flows?id=stringThis endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be… - POSTComplete Settings Flow
/self-service/settings?flow=stringUse this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows.… - GETCreate Settings Flow for Native Apps
/self-service/settings/api?organization=stringThis endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for… - GETCreate Settings Flow for Browsers
/self-service/settings/browser?return_to=string&organization=stringThis endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to selfservice.flows.settings.ui_url with the… - GETGet Settings Flow
/self-service/settings/flows?id=stringWhen accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set.… - POSTComplete Verification Flow
/self-service/verification?flow=string&token=stringUse this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: choose_method expects… - GETCreate Verification Flow for Native Apps
/self-service/verification/api?return_to=stringThis endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call… - GETCreate Verification Flow for Browser Clients
/self-service/verification/browser?return_to=stringThis endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to selfservice.flows.verification.ui_url… - GETGet Verification Flow
/self-service/verification/flows?id=stringThis endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be… - GETGet My Active Sessions
/sessions?per_page=250&page=0&page_size=250&page_token=stringThis endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the /sessions/whoami… - DELETEDisable my other sessions
/sessionsCalling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. - GETExchange Session Token
/sessions/token-exchange?init_code=string&return_to_code=string - GETCheck Who the Current HTTP Session Belongs To
/sessions/whoami?tokenize_as=stringUses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401… - DELETEDisable one of my sessions
/sessions/:idCalling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
courier
- GETList Messages
/admin/courier/messages?page_size=250&page_token=string&status=queued&recipient=stringLists all messages by given status and recipient. - GETGet a Message
/admin/courier/messages/:idGets a specific messages by the given ID.
metadata
- GETReturn Running Software Version.
/versionThis endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to…
wellknown
- GETDiscover Well-Known JSON Web Keys
/.well-known/jwks.jsonThis endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used…
oidc
- GETOpenID Connect Discovery
/.well-known/openid-configurationA mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to interact with it, including its… - POSTIssues a Verifiable Credential
/credentialsThis endpoint creates a verifiable credential that attests that the user authenticated with the provided access token owns a certain public/private key pair.… - POSTRegister OAuth2 Client using OpenID Dynamic Client Registration
/oauth2/registerThis endpoint behaves like the administrative counterpart (createOAuth2Client) but is capable of facing the public internet directly and can be used in… - GETGet OAuth2 Client using OpenID Dynamic Client Registration
/oauth2/register/:idThis endpoint behaves like the administrative counterpart (getOAuth2Client) but is capable of facing the public internet directly and can be used in… - PUTSet OAuth2 Client using OpenID Dynamic Client Registration
/oauth2/register/:idThis endpoint behaves like the administrative counterpart (setOAuth2Client) but is capable of facing the public internet directly to be used by third parties.… - DELETEDelete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol
/oauth2/register/:idThis endpoint behaves like the administrative counterpart (deleteOAuth2Client) but is capable of facing the public internet directly and can be used in… - GETOpenID Connect Front- and Back-channel Enabled Logout
/oauth2/sessions/logoutThis endpoint initiates and completes user logout at the Ory OAuth2 & OpenID provider and initiates OpenID Connect Front- / Back-channel logout:… - GETOpenID Connect Userinfo
/userinfoThis endpoint returns the payload of the ID Token, including session.id_token values, of the provided OAuth 2.0 Access Token's consent request. In the case of…
oAuth2
- GETList OAuth 2.0 Clients
/admin/clients?page_size=250&page_token=string&client_name=string&owner=stringThis endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. - POSTCreate OAuth 2.0 Client
/admin/clientsCreate a new OAuth 2.0 client. If you pass client_secret the secret is used, otherwise a random secret is generated. The secret is echoed in the response. It… - GETGet an OAuth 2.0 Client
/admin/clients/:idGet an OAuth 2.0 client by its ID. This endpoint never returns the client secret. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows.… - PUTSet OAuth 2.0 Client
/admin/clients/:idReplaces an existing OAuth 2.0 Client with the payload you send. If you pass client_secret the secret is used, otherwise the existing secret is used. Rotated… - DELETEDelete OAuth 2.0 Client
/admin/clients/:idDelete an existing OAuth 2.0 Client by its ID. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are… - PATCHPatch OAuth 2.0 Client
/admin/clients/:idPatch an existing OAuth 2.0 Client using JSON Patch. If you update client_secret, the secret will be updated and returned via the API. This is the only time… - PUTSet OAuth2 Client Token Lifespans
/admin/clients/:id/lifespansSet lifespans of different token types issued for this OAuth 2.0 client. Does not modify other fields. - POSTRotate OAuth 2.0 Client Secret
/admin/clients/:id/secrets/rotateRotates an OAuth 2.0 client's secrets. The old secret will remain valid for authentication, allowing for zero-downtime secret rotations. A new secret will be… - DELETEDelete Rotated OAuth 2.0 Client Secrets
/admin/clients/:id/secrets/rotateRemoves all rotated secrets from an OAuth 2.0 client. This should be called after all services have been updated to use the new secret and the old secrets are… - GETGet OAuth 2.0 Consent Request
/admin/oauth2/auth/requests/consent?consent_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell Ory now… - PUTAccept OAuth 2.0 Consent Request
/admin/oauth2/auth/requests/consent/accept?consent_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell Ory now… - PUTReject OAuth 2.0 Consent Request
/admin/oauth2/auth/requests/consent/reject?consent_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell Ory now… - PUTAccepts a device grant user_code request
/admin/oauth2/auth/requests/device/accept?device_challenge=stringAccepts a device grant user_code request - GETGet OAuth 2.0 Login Request
/admin/oauth2/auth/requests/login?login_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell the Ory… - PUTAccept OAuth 2.0 Login Request
/admin/oauth2/auth/requests/login/accept?login_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell the Ory… - PUTReject OAuth 2.0 Login Request
/admin/oauth2/auth/requests/login/reject?login_challenge=stringWhen an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider to authenticate the subject and then tell the Ory… - GETGet OAuth 2.0 Session Logout Request
/admin/oauth2/auth/requests/logout?logout_challenge=stringUse this endpoint to fetch an Ory OAuth 2.0 logout request. - PUTAccept OAuth 2.0 Session Logout Request
/admin/oauth2/auth/requests/logout/accept?logout_challenge=stringWhen a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to confirm that logout request. The… - PUTReject OAuth 2.0 Session Logout Request
/admin/oauth2/auth/requests/logout/reject?logout_challenge=stringWhen a user or an application requests Ory OAuth 2.0 to remove the session state of a subject, this endpoint is used to deny that logout request. No HTTP… - GETList OAuth 2.0 Consent Sessions of a Subject
/admin/oauth2/auth/sessions/consent?page_size=250&page_token=string&subject=string&login_session_id=stringThis endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent… - DELETERevoke OAuth 2.0 Consent Sessions of a Subject
/admin/oauth2/auth/sessions/consent?subject=string&client=string&consent_request_id=string&all=trueThis endpoint revokes a subject's granted consent sessions and invalidates all associated OAuth 2.0 Access Tokens. You may also only revoke sessions for a… - DELETERevokes OAuth 2.0 Login Sessions by either a Subject or a SessionID
/admin/oauth2/auth/sessions/login?subject=string&sid=stringThis endpoint invalidates authentication sessions. After revoking the authentication session(s), the subject has to re-authenticate at the Ory OAuth2… - POSTIntrospect OAuth2 Access and Refresh Tokens
/admin/oauth2/introspectThe introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token… - DELETEDelete OAuth 2.0 Access Tokens from specific OAuth 2.0 Client
/admin/oauth2/tokens?client_id=stringThis endpoint deletes OAuth2 access tokens issued to an OAuth 2.0 Client from the database. - GETList Trusted OAuth2 JWT Bearer Grant Type Issuers
/admin/trust/grants/jwt-bearer/issuers?page_size=250&page_token=string&issuer=stringUse this endpoint to list all trusted JWT Bearer Grant Type Issuers. - POSTTrust OAuth2 JWT Bearer Grant Type Issuer
/admin/trust/grants/jwt-bearer/issuersUse this endpoint to establish a trust relationship for a JWT issuer to perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and… - GETGet Trusted OAuth2 JWT Bearer Grant Type Issuer
/admin/trust/grants/jwt-bearer/issuers/:idUse this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship. - DELETEDelete Trusted OAuth2 JWT Bearer Grant Type Issuer
/admin/trust/grants/jwt-bearer/issuers/:idUse this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship. Once deleted, the… - GETOAuth 2.0 Authorize Endpoint
/oauth2/auth?resource=stringUse open source libraries to perform OAuth 2.0 and OpenID Connect available for any programming language. You can find a list of libraries at… - POSTThe OAuth 2.0 Device Authorize Endpoint
/oauth2/device/authThis endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a… - GETOAuth 2.0 Device Verification Endpoint
/oauth2/device/verifyThis is the device user verification endpoint. The user is redirected here when trying to log in using the device flow. - POSTRevoke OAuth 2.0 Access or Refresh Token
/oauth2/revokeRevoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a… - POSTThe OAuth 2.0 Token Endpoint
/oauth2/tokenUse open source libraries to perform OAuth 2.0 and OpenID Connect available for any programming language. You can find a list of libraries here…
jwk
- GETRetrieve a JSON Web Key Set
/admin/keys/:setThis endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents… - PUTUpdate a JSON Web Key Set
/admin/keys/:setUse this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. This operation replaces the entire JSON Web Key Set:… - POSTCreate JSON Web Key
/admin/keys/:setThis endpoint is capable of generating JSON Web Key Sets for you. There are different strategies available, such as symmetric cryptographic keys (HS256,… - DELETEDelete JSON Web Key Set
/admin/keys/:setUse this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data… - GETGet JSON Web Key
/admin/keys/:set/:kidThis endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid). While… - PUTSet JSON Web Key
/admin/keys/:set/:kidUse this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. The key is created or updated under the {kid} path… - DELETEDelete JSON Web Key
/admin/keys/:set/:kidUse this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic…
relationship
- PUTCreate a Relationship
/admin/relation-tuplesUse this endpoint to create a relationship. - DELETEDelete Relationships
/admin/relation-tuples?namespace=string&object=string&relation=string&subject_id=string&subject_set.namespace=string&subject_set.object=string&subject_set.relation=stringUse this endpoint to delete relationships - PATCHPatch Multiple Relationships
/admin/relation-tuplesUse this endpoint to patch one or more relationships. - GETQuery namespaces
/namespacesGet all namespaces - POSTCheck the syntax of an OPL file
/opl/syntax/checkThe OPL file is expected in the body of the request. - GETQuery relationships
/relation-tuples?page_size=250&page_token=string&namespace=string&object=string&relation=string&subject_id=string&subject_set.namespace=string&subject_set.object=string&subject_set.relation=stringGet all relationships that match the query. Only the namespace field is required.
elements
- GETGet Ory Elements configuration
/elements/configurationReturns a subset of the project's configuration for the given host. The response only contains non-sensitive data that is used to customize the behavior of…
project
- GETList All Projects
https://api.console.ory.sh/projectsLists all projects you have access to. - POSTCreate a Project
https://api.console.ory.sh/projectsCreates a new project. - GETGet an Ory Network Project Configuration
https://api.console.ory.sh/projects/:project_idReturns the project rendered into the configuration format the open source projects use (e.g. Ory Kratos for Identity, Ory Keto for Permissions), including… - PUTUpdate an Ory Network Project Configuration
https://api.console.ory.sh/projects/:project_idThis endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully… - DELETEIrrecoverably purge a project
https://api.console.ory.sh/projects/:project_id!! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete… - PATCHPatch an Ory Network Project Configuration
https://api.console.ory.sh/projects/:project_idDeprecated: Use the patchProjectWithRevision endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch… - POSTValidate an Ory Permission Language document
https://api.console.ory.sh/projects/:project_id/opl/validateParses an OPL document using the same product limits and subscription entitlements applied when the project's configuration is saved. - GETList all Enterprise SSO organizations
https://api.console.ory.sh/projects/:project_id/organizations?page_size=250&page_token=string&domain=stringDeprecated: use getProject instead Lists all Enterprise SSO organizations in a project. - POSTCreate an Enterprise SSO Organization
https://api.console.ory.sh/projects/:project_id/organizationsDeprecated: use setProject or patchProjectWithRevision instead Creates an Enterprise SSO Organization in a project. - GETGet Enterprise SSO Organization by ID
https://api.console.ory.sh/projects/:project_id/organizations/:organization_idDeprecated: use getProject instead Retrieves an Enterprise SSO Organization for a project by its ID - PUTUpdate an Enterprise SSO Organization
https://api.console.ory.sh/projects/:project_id/organizations/:organization_idDeprecated: use setProject or patchProjectWithRevision instead Updates an Enterprise SSO Organization in a project by its ID. - DELETEDelete Enterprise SSO Organization
https://api.console.ory.sh/projects/:project_id/organizations/:organization_idDeprecated: use setProject or patchProjectWithRevision instead Irrecoverably deletes an Enterprise SSO Organization in a project by its ID. - GETGet the organization onboarding portal links
https://api.console.ory.sh/projects/:project_id/organizations/:organization_id/onboarding-portal-linksRetrieves the organization onboarding portal links. - POSTCreate organization onboarding portal link
https://api.console.ory.sh/projects/:project_id/organizations/:organization_id/onboarding-portal-linksCreate a onboarding portal link for an organization. - POSTUpdate organization onboarding portal link
https://api.console.ory.sh/projects/:project_id/organizations/:organization_id/onboarding-portal-links/:onboarding_portal_link_idUpdate a onboarding portal link for an organization. - DELETEDelete an organization onboarding portal link
https://api.console.ory.sh/projects/:project_id/organizations/:organization_id/onboarding-portal-links/:onboarding_portal_link_idDeletes a onboarding portal link for an organization. - PATCHPatch an Ory Network Project Configuration based on a revision ID
https://api.console.ory.sh/projects/:project_id/revision/:revision_idThis endpoints allows you to patch individual Ory Network Project configuration keys for Ory's services (identity, permission, ...). The configuration format… - GETGet all members associated with this project
https://api.console.ory.sh/projects/:project/membersThis endpoint requires the user to be a member of the project with the role OWNER or DEVELOPER. - DELETERemove a member associated with this project
https://api.console.ory.sh/projects/:project/members/:memberThis also closes their open invites to this project: accepted invites become removed and pending invites become cancelled. This endpoint requires the user to… - GETList a project's API keys
https://api.console.ory.sh/projects/:project/tokensA list of all the project's API keys. - POSTCreate project API key
https://api.console.ory.sh/projects/:project/tokensCreate an API key for a project. - DELETEDelete project API key
https://api.console.ory.sh/projects/:project/tokens/:token_idDeletes an API key and immediately removes it.
events
- GETList all event streams for the project. This endpoint is not paginated.
https://api.console.ory.sh/projects/:project_id/eventstreams - POSTCreate an event stream for your project.
https://api.console.ory.sh/projects/:project_id/eventstreams - PUTUpdate an event stream for a project.
https://api.console.ory.sh/projects/:project_id/eventstreams/:event_stream_id - DELETERemove an event stream from a project
https://api.console.ory.sh/projects/:project_id/eventstreams/:event_stream_idRemove an event stream from a project.
permission
- POSTBatch check permissions
/relation-tuples/batch/check?max-depth=0To learn how relationship tuples and the check works, head over to the documentation. - GETCheck a permission
/relation-tuples/check?namespace=string&object=string&relation=string&subject_id=string&subject_set.namespace=string&subject_set.object=string&subject_set.relation=string&max-depth=0To learn how relationship tuples and the check works, head over to the documentation. - POSTCheck a permission
/relation-tuples/check?max-depth=0To learn how relationship tuples and the check works, head over to the documentation. - GETCheck a permission
/relation-tuples/check/openapi?namespace=string&object=string&relation=string&subject_id=string&subject_set.namespace=string&subject_set.object=string&subject_set.relation=string&max-depth=0To learn how relationship tuples and the check works, head over to the documentation. - POSTCheck a permission
/relation-tuples/check/openapi?max-depth=0To learn how relationship tuples and the check works, head over to the documentation. - GETExpand a Relationship into permissions.
/relation-tuples/expand?namespace=string&object=string&relation=string&max-depth=0Use this endpoint to expand a relationship tuple into permissions.
ApiKeys
- POSTBatch Verify API Keys
/v2alpha1/admin/apiKeys:batchVerifyVerifies multiple credentials in a single request. Efficiently verifies up to 100 credentials in parallel. Each credential is verified independently; partial… - POSTDerive Token
/v2alpha1/admin/apiKeys:deriveMints a short-lived JWT or Macaroon token from an issued or imported root API key. Derived JWTs and Macaroons cannot mint successor tokens. The derived token… - POSTVerify API Key
/v2alpha1/admin/apiKeys:verifyVerifies a single API key or derived token. Validates the credential's signature, expiration, and revocation status. Works with any credential type (issued… - GETList Imported API Keys
/v2alpha1/admin/importedApiKeys?page_size=0&page_token=string&filter=stringLists all imported keys with filtering. Returns imported keys only (not issued keys). Supports pagination and AIP-160 filter expressions. GET… - POSTImport API Key
/v2alpha1/admin/importedApiKeysImports an external API key into the system. Allows importing keys from legacy systems or external providers. The raw key is hashed and stored securely… - GETGet Imported API Key
/v2alpha1/admin/importedApiKeys/:key_idRetrieves details about a specific imported key. Returns metadata about the imported key. The original raw key is never returned. GET… - DELETEDelete Imported API Key
/v2alpha1/admin/importedApiKeys/:key_idPermanently deletes an imported key (hard delete). The key is removed from the database. Use AdminRevokeImportedApiKey for soft deletion (recommended). DELETE… - PATCHUpdate Imported API Key
/v2alpha1/admin/importedApiKeys/:key_id?update_mask=stringUpdates metadata, scopes, or rate limits of an imported key. Supports partial updates via the update_mask query parameter (AIP-134). Omitting update_mask is… - POSTRevoke Imported API Key
/v2alpha1/admin/importedApiKeys/:key_id:revokeImmediately revokes an imported API key. Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are… - POSTBatch Import API Keys
/v2alpha1/admin/importedApiKeys:batchCreateImports up to 1000 external API keys in one request. Returns per-item results. If at least one item succeeds, response is 200 OK. If all items fail, the… - GETList Issued API Keys
/v2alpha1/admin/issuedApiKeys?page_size=0&page_token=string&filter=stringLists issued API keys with optional filtering. Supports cursor-based pagination and AIP-160 filter expressions. Returns only issued (generated) API keys; use… - POSTIssue API Key
/v2alpha1/admin/issuedApiKeysCreates a new API key for a given actor. The secret is returned only once in the response and cannot be retrieved later. Keys can be scoped with specific… - GETGet Issued API Key
/v2alpha1/admin/issuedApiKeys/:key_idRetrieves details about a specific issued API key including its status, scopes, expiration, and usage statistics. The secret is never returned. GET… - PATCHUpdate Issued API Key
/v2alpha1/admin/issuedApiKeys/:key_id?update_mask=stringUpdates metadata, scopes, or rate limits of an issued key without rotating the secret. Use RotateIssuedApiKey to change the secret. Follows AIP-134: the… - POSTRevoke Issued API Key
/v2alpha1/admin/issuedApiKeys/:key_id:revokeImmediately revokes an issued API key. Once revoked, the key can no longer be used for authentication. This operation is irreversible. Revoked keys are… - POSTRotate Issued API Key
/v2alpha1/admin/issuedApiKeys/:key_id:rotateGenerates a new secret for an issued API key. Creates a new API key with a new key_id and secret, and immediately revokes the old key. This is the recommended… - POSTRevoke API Key (self-service)
/v2alpha1/apiKeys:selfRevokeProof-of-possession variant of revocation. The Self* prefix on the request/response messages disambiguates from the admin variants (AdminRevokeIssuedApiKey /… - GETGet JWKS
/v2alpha1/derivedKeys/jwks.jsonReturns the JSON Web Key Set for token verification. Provides the public keys needed to verify JWT tokens issued by this service. Keys are loaded from…
workspace
- GETList workspaces the user is a member of
https://api.console.ory.sh/workspaces?page_size=250&page_token=string - POSTCreate a new workspace
https://api.console.ory.sh/workspaces - GETGet a workspace
https://api.console.ory.sh/workspaces/:workspaceAny workspace member can access this endpoint. - PUTUpdate an workspace
https://api.console.ory.sh/workspaces/:workspaceWorkspace members with the role OWNER can access this endpoint. - GETList all projects of a workspace
https://api.console.ory.sh/workspaces/:workspace/projectsAny workspace member can access this endpoint. - GETList a workspace's API keys
https://api.console.ory.sh/workspaces/:workspace/tokensA list of all the workspace's API keys. - POSTCreate workspace API key
https://api.console.ory.sh/workspaces/:workspace/tokensCreate an API key for a workspace. - DELETEDelete workspace API key
https://api.console.ory.sh/workspaces/:workspace/tokens/:token_idDeletes an API key and immediately removes it.
API details
- Base URL
https://{project_slug}.projects.oryapis.com- Authentication
- HTTP Basic authentication (username and password)
A bearer token in the Authorization header
OAuth 2.0 (authorization code flow) with 3 scopes
A bearer token in the Authorization header
A bearer token in the Authorization header - Operations
- 179 operations on 130 pathsGET 80POST 46DELETE 26PUT 18PATCH 9
- Main resources
- frontend 41oAuth2 33project 22identity 21ApiKeys 18oidc 8workspace 8jwk 7permission 6relationship 6
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
v1.22.94 - Links
- OpenAPI document
- Listed from
- Ory (Network SDK)'s published OpenAPI description (ory/sdk) (Apache-2.0)
How to test the Ory APIs in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Ory APIs collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Identities” (GET /admin/identities?per_page=250&page=0&page_size=250&page_token=string&consistency=&ids=string&credentials_identifier=string&preview_credentials_identifier_similar=string&include_credential=string&organization_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Ory APIs?
Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public… It is listed under Identity & security and has 179 endpoints.
Who publishes the Ory APIs?
It is listed from Ory (Network SDK)'s public API description (an OpenAPI document), not published by Ory (Network SDK) on Swastik Codes. Anyone who controls ory.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Ory APIs?
Requests go to https://{project_slug}.projects.oryapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Ory APIs?
It accepts 5 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header; OAuth 2.0 (authorization code flow) with 3 scopes; A bearer token in the Authorization header; A bearer token in the Authorization header.
How many endpoints does the Ory APIs have?
179 operations on 130 paths (80 GET, 46 POST, 26 DELETE, 18 PUT, 9 PATCH). The largest groups are frontend, oAuth2, project, identity.
Is forking the Ory APIs free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.