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

Topaz Directory Relations API

Relations (tuples) connecting subjects to objects in the directory graph.

Topaz Directory Relations API is one of 5 APIs that Topaz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Directory Relations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 3 base URLs: https://localhost:8383, https://authorizer.prod.aserto.com, https://directory.prod.aserto.com.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://localhost:8383
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Topaz Directory Relations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — Self-hosted Topaz may run with no authentication (default), with a static API key, or behind mTLS. When keys are configured (and on the Aserto hosted service)…

Paths & Operations 4

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

Directory Relations 4

Relations (tuples) connecting subjects to objects in the directory graph.

GET
/api/v3/directory/relation
Get relation
getRelation 5 params → 200401404
POST
/api/v3/directory/relation
Set relation
setRelation body → 200401
DELETE
/api/v3/directory/relation
Delete relation
deleteRelation 5 params → 200401
GET
/api/v3/directory/relations
List relations
getRelations 7 params → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Relation (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Relation
object
5 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

topaz-directory-relations-api-openapi.yml Raw ↑

Other APIs Topaz publishes across the network.

Topaz Authorizer API
Topaz Directory Checks API
Topaz Directory Objects API
Topaz Policies API
Where this information came from

This is an independent, third-party profile of Topaz Directory Relations 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.