Skip to content
Proud to collaborate with Microsoft for Startups

identity.membership.update-role ​

Change a member's role in an organization

Change a member's role in an organization.

Inputs:

  • membership_uuid: Membership UUID (required)
  • organization_uuid: Organization ID for tenant check (required)
  • role: New role — member | admin | owner (required)
  • actor: Actor Cognito sub or user UUID (required)
  • force: Allow demoting the last owner (optional, default False)

Outputs (terminal state_data):

  • membership_uuid
  • previous_role
  • new_role
  • updated_at

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
membership_uuiduuidYes——
organization_uuiduuidYes——
rolestringYes——
actorstringYes——
forcebooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
membership_uuidstringYes——
previous_rolestringNo——
new_rolestringYes——
updated_atstringNo——
organization_uuiduuidNo——
rolestringNo——
actorstringNo——
forcebooleanNo——
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.update-role",
  "initial_data": {
    "membership_uuid": "value",
    "organization_uuid": "value",
    "role": "value",
    "actor": "value"
  }
}