Skip to main content
Use SignPath through Corsair: one client, typed API calls. Create an API token in SignPath under your user settings, API tokens. The token acts as the user who owns it, so use a dedicated CI user for automation. A token belongs to one user in one organization, and every route carries that organization’s id, so set organizationId once on the plugin or store organization_id on the account. Things to know before you sign:
  • Signing is asynchronous. The three submit operations return as soon as SignPath queues the work. Poll signingRequests.getStatus until isFinalStatus is true. The plugin declares those three as jobs, so get_job follows the same status field. resubmit returns the new request’s id (read from the Location header SignPath answers with); poll it with signingRequests.getStatus.
  • Nothing is signed until the policy says so. A signing policy with numberOfRequiredApprovals above zero holds each request in WaitingForApproval until enough approvers call signingRequests.approve. signingRequests.deny rejects a request permanently, and signingRequests.cancel stops one that has not finished; neither can be undone.
  • Creating is not enabling. A new project, signing policy and artifact configuration is inactive. Call the matching activate operation, or the configuration will refuse submissions.
  • Pick the upload route by artifact size. submitWithArtifact sends the bytes in one multipart request (base64 in the input). submitWithArtifactRetrievalLink has SignPath download the artifact from a URL you provide, which is what SignPath documents for large files. submitWithoutArtifact returns an uploadLink you deliver the artifact to afterwards.
  • Hash and message signing answer immediately. signingRequests.signHash and signingRequests.signMessage return the signature in the response, with no artifact and no waiting period. Each needs its algorithm’s options object, and the schema rejects the call before sending when it is missing.
  • Artifact configurations are XML. artifactConfigurations.getXml returns the document as text, and updateXml replaces it wholesale; SignPath does not merge.
  • Paging. signingRequests.list returns pagination.nextLink, a full URL that already contains your filters. Pass it back as nextLink to read the next page. auditLog.listEvents pages with pagination.nextCursor instead.
  • Downloads are not wrapped. signingRequests.get returns signedArtifactLink; fetching that link returns the binary itself, which this plugin does not stream.
  • Preview route. The two audit log operations call v1-pre, the preview path SignPath keeps them under.
What you get:
  • 34 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

Check whether a signing request finished
Submit an artifact for signing
See the full list on the API page.

What’s next

API reference

Every signpath.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.