Skip to content

Reference

The Reference section is exhaustive enumeration for lookup. When a guide doesn’t cover your edge case, when you need to know exactly what an API endpoint returns, when you’re comparing RBAC permissions across roles β€” Reference is the source of truth.

Most reference content is auto-generated from the AtmanID source code, which means it stays in sync with the product automatically with no manual maintenance step.

What’s in this section

Sub-section Source Status
API Reference Generated from the API’s own schemas β†’ OpenAPI 3.1 spec at /openapi.json βœ… LIVE β€” 50 endpoint paths (63 operations), interactive explorer on the reference page
SDK Reference Hand-written guide today; a reference generated from the SDK’s documentation comments is planned βœ… LIVE (guide)

Not yet published (planned)

  • Iris Tool Catalog β€” a searchable table of every metric and dimension Iris can query. Planned.
  • RBAC Matrix β€” every platform role Γ— every permission, generated from the platform’s permission model. Planned.
  • Audit Event Taxonomy β€” every audit event type emitted by the platform. Planned.
  • Connector Capability Matrix β€” every shipped connector Γ— what it syncs (users, accounts, entitlements, groups). Planned.
  • Glossary β€” defined terms with stable links. Planned.
  • Error Code Reference β€” every API error code, what it means, how to resolve. Planned.

Adjacent sections

  • Tutorials β€” for worked examples that put reference material into context
  • Concepts β€” for the why behind the API design and security model
  • Iris β€” the natural-language layer that wraps most reference functionality

Β© AtmanID Β· Privacy