Skip to content

docs(api): add common multi-step API tasks page - #462

Open
mindymo wants to merge 1 commit into
mainfrom
docs/api-common-tasks-cookbook
Open

docs(api): add common multi-step API tasks page#462
mindymo wants to merge 1 commit into
mainfrom
docs/api-common-tasks-cookbook

Conversation

@mindymo

@mindymo mindymo commented Aug 18, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds conductorone-api/common-tasks.mdx, a cookbook page covering API tasks that require chaining 2+ calls (e.g. adding an entitlement to an access profile, checking provisioning status, extending/removing a grant's expiration, executing an automation and checking its result).
  • Wires the new page into the API tab nav in docs.json, after pagination.
  • Motivated by analysis of the docs assistant's chat logs: many customer questions asked for exactly these call chains, which aren't covered by the auto-generated per-endpoint reference (which documents one endpoint at a time, not workflows).

Review notes

Several steps are marked with <Warning> callouts as Needs verification — these are our best reconstruction from the API reference, not confirmed against a live tenant:

  • Whether an entitlement's risk level attribute value can actually be attached to a specific entitlement, and via which endpoint/field (couldn't find this in the reference at all).
  • The exact taskTypes/taskStates semantics for counting access profile provisioning completion.
  • The full set of automation execution state values.
  • Whether a service principal can be set as an app owner via the API (the reference doesn't say either way).

Requesting review from someone on the sales engineering team to confirm/correct these before this goes out more broadly.

Test plan

  • Verify the flagged endpoints/behaviors against a live tenant
  • Preview the page renders correctly in Mintlify

Chat-log analysis of the docs assistant showed customers repeatedly asking for API call chains (e.g. checking access profile provisioning status, extending a grant's expiration) that aren't covered by any single endpoint reference page. Adds a cookbook-style page walking through these chains, with a few steps flagged for engineering verification before wider review.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
conductorone 🟢 Ready View Preview Aug 18, 2026, 9:46 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant