Skip to content
Proud to collaborate with Microsoft for Startups

identity.membership.get ​

Fetch a single membership by UUID, tenant-verified

Get a single membership by UUID, tenant-verified via organization_uuid.

Inputs:

  • membership_uuid: Membership UUID (required)
  • organization_uuid: Organization ID for tenant verification (required)

Outputs (terminal state_data):

  • membership: dict | None
  • found: bool

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
membership_uuiduuidYes—Membership UUID
organization_uuiduuidYes—Organization UUID for tenant verification

Output Schema ​

FieldTypeRequiredDefaultDescription
membershipjsonNo——
foundbooleanYes——
membership_uuidstringNo——
organization_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

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

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "identity.membership.get",
  "initial_data": {
    "membership_uuid": "value",
    "organization_uuid": "value"
  }
}