Skip to main content
Parmana External Connector API. Connect your own system with no Parmana code change: list the registrations, propose registering a capability to your HTTPS endpoint or revoking it, and approve or reject a proposal with a signed step up authorization. Every call needs an API key that belongs to a verified human.

​
ExternalConnectorApi Objects

External Connector API.

​
list

Every registration, active and revoked. Maps to GET /external-connectors.

​
propose_register

Propose registering a capability to your HTTPS endpoint. Maps to POST /external-connectors/changes with action “register”. capability is namespace:action, outside the built in namespaces (paytm, hubspot, github, slack, test). endpoint_url is https with a public host name. allowed_parameters may be empty. timeout_ms is 1000 to 30000; the server defaults it to 10000. Nothing changes until a different person approves it.

​
propose_revoke

Propose revoking the active registration for a capability. Maps to POST /external-connectors/changes with action “revoke”.

​
list_changes

List external connector changes, newest first. Maps to GET /external-connectors/changes.

​
Parameters

status: “PENDING_APPROVAL”, “APPROVED” or “REJECTED”. Omit for all.

​
approve_change

Approve and apply an external connector change. Maps to POST /external-connectors/changes/{id}/approve. The caller must not be the proposer and must have a registered step up key. Make step_up_authorization with parmana.crypto.sign_policy_change_step_up(), change_id as pending_policy_change_id, and action “approve”.

​
reject_change

Reject an external connector change. Maps to POST /external-connectors/changes/{id}/reject. Same caller rules as approve_change(); sign with action “reject”.