SailPointAPI style & design guidelines

Design APIs with intention.

Opinionated guard rails for designing consistent, secure, evolvable APIs—built for teams shipping integrations to customers and partners.

Start hereBrowse rulesRead guides

Normative

Rules

The must/should guidance. Each rule is stable, linkable, and tracked by ID.

Open Rules

Non-normative

Guides

Rationale, patterns, and examples that support the rules and help teams apply them.

Open Guides

Tooling

Search & automation

Use site search (⌘ K) or consume the rules as JSON.

Start hererules.json

How to use this hub

  • Start with the overview to align on principles and terminology.
  • Apply Rules during API design, reviews, and implementation.
  • Use Guides for rationale, patterns, and examples.
  • Reference Appendices for checklists, glossary, and recipe-style guidance.

External readers

Use Rules as a contract checklist and Guides/Appendices for practical patterns.

Internal teams

Cite rule IDs in reviews and keep OpenAPI as the single source of truth.

Popular rule categories

Open source API guideline hub for SailPoint teams, customers, and partners.

View on GitHub