Home Start here SailPoint API Guidelines Principles Conventions

Appendices Glossary Review checklist Compatibility checklist OpenAPI snippet library Optimistic locking Pagination recipes

Appendices

Appendices

Reference material, recipes, and reusable patterns that support the Rules.

Appendices

This section contains supporting material that is useful in day-to-day API design and review:

Patterns that apply across multiple rules (e.g., optimistic locking, pagination strategies)
Reusable reference (glossary, checklists, OpenAPI snippets)

Reference

Glossary
Review checklist
Compatibility checklist
OpenAPI snippet library

Recipes

Optimistic locking
Pagination recipes

Authentication, authorization, & scopes

OAuth patterns, scope design, and how to document auth requirements in OpenAPI.

Glossary

Shared terminology used across Rules, Guides, and Appendices.

On this page