Partner API onboarding with credential revocation on failure

Provision scoped partner access and validate conformance before activation; failed onboarding revokes credentials and removes provisional routing. Editable collaboration with role lanes, decisions and explicit rollback activities. Illustrative policy and timing; adapt to local requirements.
BPMN 2.0AI & Pipelines BPMN 2.0 syntax docs
Template previewBPMN 2.0
Rendering…
What this template contains

Source: 71 lines
Make it your own.

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="api_partner_onboarding_definitions" targetNamespace="urn:flowss:advanced">
  <bpmn:message id="api_partner_onboarding_message" name="Partner integration approved"/>
  
  <bpmn:process id="api_partner_onboarding_process" name="Partner API onboarding with credential revocation on failure" isExecutable="false">
    <bpmn:documentation>Provision scoped partner access and validate conformance before activation; failed onboarding revokes credentials and removes provisional routing. Inputs: Partner integration approved. Rollback activities are explicit modelled tasks, not engine-level BPMN compensation handlers. All policy choices, durations and conditions are illustrative. Replace example rules with approved local policy; configure integrations and review before execution. This non-executable template does not assert legal compliance or a real completed case.</bpmn:documentation>
    <bpmn:laneSet id="api_partner_onboarding_lanes"><bpmn:lane id="api_partner_onboarding_lane_0" name="Integration operator"><bpmn:flowNodeRef>api_partner_onboarding_start</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_intake_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_prepare_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_prepare_2</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_prepare_3</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_commit_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_commit_rest_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_complete</bpmn:flowNodeRef></bpmn:lane><bpmn:lane id="api_partner_onboarding_lane_1" name="Conformance reviewer"><bpmn:flowNodeRef>api_partner_onboarding_verification</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_decision</bpmn:flowNodeRef></bpmn:lane><bpmn:lane id="api_partner_onboarding_lane_2" name="Security recovery"><bpmn:flowNodeRef>api_partner_onboarding_rollback_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_rollback_rest_1</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_rollback_rest_2</bpmn:flowNodeRef><bpmn:flowNodeRef>api_partner_onboarding_alternate</bpmn:flowNodeRef></bpmn:lane></bpmn:laneSet>
    <bpmn:startEvent id="api_partner_onboarding_start" name="Partner integration approved"><bpmn:messageEventDefinition id="api_partner_onboarding_start_def" messageRef="api_partner_onboarding_message"/></bpmn:startEvent>
    <bpmn:userTask id="api_partner_onboarding_intake_1" name="Register approved API scope"></bpmn:userTask>
    <bpmn:userTask id="api_partner_onboarding_prepare_1" name="Provision sandbox credentials"></bpmn:userTask>
    <bpmn:userTask id="api_partner_onboarding_prepare_2" name="Configure quota policy"></bpmn:userTask>
    <bpmn:userTask id="api_partner_onboarding_prepare_3" name="Run contract tests"></bpmn:userTask>
    <bpmn:userTask id="api_partner_onboarding_verification" name="Verify webhook signing"></bpmn:userTask>
    <bpmn:exclusiveGateway id="api_partner_onboarding_decision" name="Integration conforms?" default="api_partner_onboarding_flow_8"></bpmn:exclusiveGateway>
    <bpmn:serviceTask id="api_partner_onboarding_commit_1" name="Activate production scope"></bpmn:serviceTask>
    <bpmn:serviceTask id="api_partner_onboarding_rollback_1" name="Revoke provisional credentials"></bpmn:serviceTask>
    <bpmn:serviceTask id="api_partner_onboarding_commit_rest_1" name="Publish support ownership"></bpmn:serviceTask>
    <bpmn:serviceTask id="api_partner_onboarding_rollback_rest_1" name="Remove candidate routing"></bpmn:serviceTask>
    <bpmn:serviceTask id="api_partner_onboarding_rollback_rest_2" name="Record failed conformance"></bpmn:serviceTask>
    <bpmn:endEvent id="api_partner_onboarding_complete" name="Partner activated"></bpmn:endEvent>
    <bpmn:endEvent id="api_partner_onboarding_alternate" name="Provisioning revoked"></bpmn:endEvent>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_1" sourceRef="api_partner_onboarding_start" targetRef="api_partner_onboarding_intake_1"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_2" sourceRef="api_partner_onboarding_intake_1" targetRef="api_partner_onboarding_prepare_1"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_3" sourceRef="api_partner_onboarding_prepare_1" targetRef="api_partner_onboarding_prepare_2"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_4" sourceRef="api_partner_onboarding_prepare_2" targetRef="api_partner_onboarding_prepare_3"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_5" sourceRef="api_partner_onboarding_prepare_3" targetRef="api_partner_onboarding_verification"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_6" sourceRef="api_partner_onboarding_verification" targetRef="api_partner_onboarding_decision"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_7" sourceRef="api_partner_onboarding_decision" targetRef="api_partner_onboarding_commit_1" name="Yes"><bpmn:conditionExpression xsi:type="bpmn:tFormalExpression">=integrationConforms = true</bpmn:conditionExpression></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_8" sourceRef="api_partner_onboarding_decision" targetRef="api_partner_onboarding_rollback_1" name="Otherwise"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_9" sourceRef="api_partner_onboarding_commit_1" targetRef="api_partner_onboarding_commit_rest_1"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_10" sourceRef="api_partner_onboarding_rollback_1" targetRef="api_partner_onboarding_rollback_rest_1"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_11" sourceRef="api_partner_onboarding_rollback_rest_1" targetRef="api_partner_onboarding_rollback_rest_2"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_12" sourceRef="api_partner_onboarding_commit_rest_1" targetRef="api_partner_onboarding_complete"></bpmn:sequenceFlow>
    <bpmn:sequenceFlow id="api_partner_onboarding_flow_13" sourceRef="api_partner_onboarding_rollback_rest_2" targetRef="api_partner_onboarding_alternate"></bpmn:sequenceFlow>
  </bpmn:process>
  <bpmn:collaboration id="api_partner_onboarding_collaboration"><bpmn:participant id="api_partner_onboarding_party" name="Integration partner"/><bpmn:participant id="api_partner_onboarding_pool" name="Partner API onboarding with credential revocation on failure" processRef="api_partner_onboarding_process"/><bpmn:messageFlow id="api_partner_onboarding_request" sourceRef="api_partner_onboarding_party" targetRef="api_partner_onboarding_start"/></bpmn:collaboration>
  <bpmndi:BPMNDiagram id="api_partner_onboarding_diagram"><bpmndi:BPMNPlane id="api_partner_onboarding_plane" bpmnElement="api_partner_onboarding_collaboration">
    <bpmndi:BPMNShape id="api_partner_onboarding_party_di" bpmnElement="api_partner_onboarding_party" isHorizontal="true"><dc:Bounds x="20" y="20" width="2420" height="70"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_pool_di" bpmnElement="api_partner_onboarding_pool" isHorizontal="true"><dc:Bounds x="20" y="180" width="2420" height="780"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_lane_0_di" bpmnElement="api_partner_onboarding_lane_0" isHorizontal="true"><dc:Bounds x="50" y="180" width="2390" height="260"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_lane_1_di" bpmnElement="api_partner_onboarding_lane_1" isHorizontal="true"><dc:Bounds x="50" y="440" width="2390" height="260"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_lane_2_di" bpmnElement="api_partner_onboarding_lane_2" isHorizontal="true"><dc:Bounds x="50" y="700" width="2390" height="260"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_start_di" bpmnElement="api_partner_onboarding_start"><dc:Bounds x="162" y="292" width="36" height="36"/><bpmndi:BPMNLabel><dc:Bounds x="108" y="335" width="144" height="40"/></bpmndi:BPMNLabel></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_intake_1_di" bpmnElement="api_partner_onboarding_intake_1"><dc:Bounds x="325" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_prepare_1_di" bpmnElement="api_partner_onboarding_prepare_1"><dc:Bounds x="535" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_prepare_2_di" bpmnElement="api_partner_onboarding_prepare_2"><dc:Bounds x="745" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_prepare_3_di" bpmnElement="api_partner_onboarding_prepare_3"><dc:Bounds x="955" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_verification_di" bpmnElement="api_partner_onboarding_verification"><dc:Bounds x="1165" y="532" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_decision_di" bpmnElement="api_partner_onboarding_decision" isMarkerVisible="true"><dc:Bounds x="1416" y="546" width="48" height="48"/><bpmndi:BPMNLabel><dc:Bounds x="1368" y="496" width="144" height="40"/></bpmndi:BPMNLabel></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_commit_1_di" bpmnElement="api_partner_onboarding_commit_1"><dc:Bounds x="1585" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_rollback_1_di" bpmnElement="api_partner_onboarding_rollback_1"><dc:Bounds x="1585" y="792" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_commit_rest_1_di" bpmnElement="api_partner_onboarding_commit_rest_1"><dc:Bounds x="1795" y="272" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_rollback_rest_1_di" bpmnElement="api_partner_onboarding_rollback_rest_1"><dc:Bounds x="1795" y="792" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_rollback_rest_2_di" bpmnElement="api_partner_onboarding_rollback_rest_2"><dc:Bounds x="2005" y="792" width="130" height="76"/></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_complete_di" bpmnElement="api_partner_onboarding_complete"><dc:Bounds x="2052" y="292" width="36" height="36"/><bpmndi:BPMNLabel><dc:Bounds x="1998" y="335" width="144" height="40"/></bpmndi:BPMNLabel></bpmndi:BPMNShape>
    <bpmndi:BPMNShape id="api_partner_onboarding_alternate_di" bpmnElement="api_partner_onboarding_alternate"><dc:Bounds x="2262" y="812" width="36" height="36"/><bpmndi:BPMNLabel><dc:Bounds x="2208" y="855" width="144" height="40"/></bpmndi:BPMNLabel></bpmndi:BPMNShape>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_1_di" bpmnElement="api_partner_onboarding_flow_1"><di:waypoint x="198" y="310"/><di:waypoint x="325" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_2_di" bpmnElement="api_partner_onboarding_flow_2"><di:waypoint x="455" y="310"/><di:waypoint x="535" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_3_di" bpmnElement="api_partner_onboarding_flow_3"><di:waypoint x="665" y="310"/><di:waypoint x="745" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_4_di" bpmnElement="api_partner_onboarding_flow_4"><di:waypoint x="875" y="310"/><di:waypoint x="955" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_5_di" bpmnElement="api_partner_onboarding_flow_5"><di:waypoint x="1085" y="310"/><di:waypoint x="1125" y="310"/><di:waypoint x="1125" y="570"/><di:waypoint x="1165" y="570"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_6_di" bpmnElement="api_partner_onboarding_flow_6"><di:waypoint x="1295" y="570"/><di:waypoint x="1416" y="570"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_7_di" bpmnElement="api_partner_onboarding_flow_7"><di:waypoint x="1464" y="570"/><di:waypoint x="1525" y="570"/><di:waypoint x="1525" y="310"/><di:waypoint x="1585" y="310"/><bpmndi:BPMNLabel><dc:Bounds x="1472" y="543" width="100" height="22"/></bpmndi:BPMNLabel></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_8_di" bpmnElement="api_partner_onboarding_flow_8"><di:waypoint x="1464" y="570"/><di:waypoint x="1525" y="570"/><di:waypoint x="1525" y="830"/><di:waypoint x="1585" y="830"/><bpmndi:BPMNLabel><dc:Bounds x="1472" y="580" width="100" height="22"/></bpmndi:BPMNLabel></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_9_di" bpmnElement="api_partner_onboarding_flow_9"><di:waypoint x="1715" y="310"/><di:waypoint x="1795" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_10_di" bpmnElement="api_partner_onboarding_flow_10"><di:waypoint x="1715" y="830"/><di:waypoint x="1795" y="830"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_11_di" bpmnElement="api_partner_onboarding_flow_11"><di:waypoint x="1925" y="830"/><di:waypoint x="2005" y="830"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_12_di" bpmnElement="api_partner_onboarding_flow_12"><di:waypoint x="1925" y="310"/><di:waypoint x="2052" y="310"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_flow_13_di" bpmnElement="api_partner_onboarding_flow_13"><di:waypoint x="2135" y="830"/><di:waypoint x="2262" y="830"/></bpmndi:BPMNEdge>
    <bpmndi:BPMNEdge id="api_partner_onboarding_request_di" bpmnElement="api_partner_onboarding_request"><di:waypoint x="180" y="90"/><di:waypoint x="180" y="292"/></bpmndi:BPMNEdge>
    
  </bpmndi:BPMNPlane></bpmndi:BPMNDiagram>
</bpmn:definitions>