identity.seat.status

Report end-user seat usage (cap / consumed / free) for an app

Report end-user seat usage for an app's identity tenant.

Inputs:

• actor: Cognito sub or user UUID (required)
• organization_uuid: owning organization (required)
• identity_app_uuid: the app's identity tenant (required)

Outputs (terminal state_data):

• cap, consumed, free, over_cap_pending
• human_seats_used, actor_seats_used: consumed split by principal kind (human_seats_used + actor_seats_used == consumed)

Overview

Property	Value
Workflow type	Atomic
Library	App-identity
Version	1.0

Input Schema

Field	Type	Required	Default	Description
actor	string	Yes	—	—
organization_uuid	uuid	Yes	—	—
identity_app_uuid	uuid	Yes	—	—

Output Schema

Field	Type	Required	Default	Description
cap	integer	Yes	—	—
consumed	integer	Yes	—	—
free	integer	Yes	—	—
over_cap_pending	integer	Yes	—	—
human_seats_used	integer	No	—	—
actor_seats_used	integer	No	—	—
actor	string	No	—	—
identity_app_uuid	uuid	No	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
reason	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "identity.seat.status",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value"
  }
}