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

Ory relationship API

The relationship API from Ory — 4 operation(s) for relationship.

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

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

This API exposes 6 operations across 4 paths, and defines 13 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.

6 operations 4 paths 13 schemas 1 DELETE2 GET1 PATCH1 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
License
Apache 2.0
Resource Areas
1

Authentication & Security 3

Ory relationship 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 6

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

relationship 6
DELETE
/admin/relation-tuples
Delete Relationships
deleteRelationships 7 params → 204400default
PATCH
/admin/relation-tuples
Patch Multiple Relationships
patchRelationships body → 204400404default
PUT
/admin/relation-tuples
Create a Relationship
createRelationship body → 201400default
GET
/namespaces
Query namespaces
listRelationshipNamespaces → 200default
POST
/opl/syntax/check
Check the syntax of an OPL file
checkOplSyntax body → 200400default
GET
/relation-tuples
Query relationships
getRelationships 9 params → 200404default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are genericError (8 properties), relationship (5 properties), createRelationshipBody (5 properties), subjectSet (3 properties). Each schema is shown below with its type and property counts.

relationship
object
Relationship
5 properties 3 required
checkOplSyntaxResult
object
1 property
relationshipNamespaces
object
Relationship Namespace List
1 property
namespace
object
1 property
relationshipPatch
object
Payload for patching a relationship
2 properties
checkOplSyntaxBody
string
Ory Permission Language Document
relationships
object
Paginated Relationship List
2 properties
errorGeneric
object
The standard Ory JSON API error format.
1 property 1 required
createRelationshipBody
object
Create Relationship Request Body
5 properties
subjectSet
object
3 properties 3 required
SourcePosition
object
2 properties
genericError
object
8 properties 1 required
ParseError
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ory-relationship-api-openapi.yml Raw ↑

Other APIs Ory publishes across the network.

Ory api API
Ory courier API
Ory frontend API
Ory identity API
Ory jwk API
Ory metadata API
Ory oAuth2 API
Ory oidc API
Ory permission API
Ory wellknown API
Ory Billing API
Ory Event Streams API
Where this information came from

This is an independent, third-party profile of Ory relationship 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.