Ironclad Capabilities

Last updated: October 7, 2024

After this article...

You'll understand the capabilities our Ironclad integration provides, and how Lumos interacts with the Ironclad API.

View users

The mapping between Ironclad user statuses and Lumos user account statuses is below.

Ironclad User Status

Lumos Account Status

active

Active

inactive

Suspended

deleted (Ironclad no longer returns a user)

Deprovisioned

Ironclad API endpoint: https://developer.ironcladapp.com/reference/retrieve-all-users (we check the active field)

View a user's entitlements

Lumos can retrieve the following user entitlements from Ironclad.

  • Ironclad Group - The Ironclad Groups the user belongs to.

Ironclad API endpoints:

Ironclad Group: https://developer.ironcladapp.com/reference/retrieve-all-groups

Ingest contracts

Lumos' integration with Ironclad can retrieve your Ironclad contract records and associated documents and place them in the Found Documents tab to help you automatically stay on top of your new vendor agreements and order forms.

Documents ingested from Ironclad show up with an Ironclad logo in the Found Documents tab.

We can filter for Ironclad contract records via parameters available on Ironclad’s APIs, so records that do not match these filters are never fetched, processed, or stored by Lumos.

If you need Lumos to adjust the filters used to query your Ironclad contract data, please contact us at support@lumos.com or via Slack.

Ironclad API endpoints:

https://developer.ironcladapp.com/reference/list-all-records (we retrieve and store all properties/workflow fields associated with the Ironclad contract record)

A few additional notes on contract fields:

  • For the Lumos contract Start Date, we get the first non-empty value of the contract record's startDate, serviceStartDate, then agreementDate(in that order).

  • For the Lumos contract End Date, we get the first non-empty value of the contract record's agreementExpirationDate, expirationDate, serviceEndDate, then terminationDate(in that order). If we don't see an end date, we assume the contract duration is 1 year.

https://developer.ironcladapp.com/reference/retrieve-a-user (we use this endpoint to get the user details associated with the contract record's workflowOwner. If that doesn't exist, we check for the workflowCreator.)

Ironclad API documentation