Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 2.26 KB

README.md

File metadata and controls

19 lines (10 loc) · 2.26 KB
Raw

Ironclad's OpenAPI Specification

This repository contains OpenAPI documents for Ironclad's API.

Files can be found in the openapi/ directory:

  • openapi.json : Ironclad's API

  • openapi-scim.json : SCIM, or the System for Cross-domain Identity Management specification, is an open standard designed to manage user identity information. SCIM provides a defined schema for representing users and groups, and a RESTful API to run CRUD operations on those user and group resources.

What is OpenAPI?

From the OpenAPI Specification:

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface document for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface documentation have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

Project Status

This project is currently in GA. We expect the spec to be accurate, and it is currently in active development. If you've identified a mismatch between Ironclad's API behavior and this specification, please open an issue.