Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ironclad Users API

Documentation on SCIM Users.

Ironclad Users API is one of 13 APIs that Ironclad publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 5 JSON Schemas.

This API exposes 6 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against 3 base URLs: https://na1.ironcladapp.com/oauth, https://eu1.ironcladapp.com/oauth, https://demo.ironcladapp.com/oauth.

6 operations 2 paths 1 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://na1.ironcladapp.com/public/api/v1
Resource Areas
1

Paths & Operations 6

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

Users 6

Documentation on SCIM Users.

GET
/Users
List all Users
retrieve-all-users 6 params → 200400403500
POST
/Users
Create a User
create-a-user 3 params body → 201400403409500
GET
/Users/{userId}
Retrieve a User
retrieve-a-user 4 params → 200403404500
PATCH
/Users/{userId}
Update User Data
update-user-data 4 params body → 200400403404500
PUT
/Users/{userId}
Replace a User
replace-a-user 4 params body → 200400403404500
DELETE
/Users/{userId}
Delete a User
delete-a-user 3 params → 204403404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is UserResponseObject (10 properties). Each schema is shown below with its type and property counts.

UserResponseObject
object
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ironclad-users-api-openapi.yml Raw ↑

Other APIs Ironclad publishes across the network.

Ironclad Clickwrap API
Ironclad Authorization API
Ironclad Entities API
Ironclad Exports API
Ironclad Groups API
Ironclad Obligations API
Ironclad Records API
Ironclad Resources API
Ironclad Schemas API
Ironclad Search API
Ironclad Webhooks API
Ironclad Workflows API