Skip to content
Proud to collaborate with Microsoft for Startups

subscription.key_provision ​

Provision a new integration key for the actor-seat pricing model

Provision an integration key tied to an organization subscription.

Writes happen in a single transaction on context.session so the seat-counter increment and the new IntegrationKey row commit together.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-subscription
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
subscription_uuiduuidYes—OrganizationSubscription UUID
namestringYes—Human-readable name for the key
created_by_user_uuiduuidNo—User UUID who requested the key (None for autonomous keys)
scopejsonNo—Optional scope dict for access control
prefixstringNo—Key prefix (default: ltik)

Output Schema ​

FieldTypeRequiredDefaultDescription
subscription_uuiduuidNo——
organization_uuiduuidNo——
integration_key_uuiduuidNo——
plaintext_secretstringNo—Returned ONCE; never persisted again
prefixstringNo——
expires_atstringNo——
key_seats_usedintegerNo——
key_seats_totalintegerNo——
is_delegatedbooleanNo——
provisioned_atstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "subscription.key_provision",
  "initial_data": {
    "organization_uuid": "value",
    "subscription_uuid": "value",
    "name": "value"
  }
}