ACT-OffboardUser

Runbook: ACT-OffboardUser.ps1

πŸ“˜ Description

This runbook performs a full offboarding workflow for a user in the customer’s hybrid/on-prem Active Directory and Exchange environment.

It includes:

  • Password reset
  • Killing all active sessions (Azure AD + Hybrid)
  • Removing all AD group memberships
  • Disabling the user account
  • Optional mailbox forwarding
  • Detailed SymphonyDesk logging
  • Jira comments + workflow transitions

This runbook is commonly used for:

  • Terminations
  • Resignations
  • Immediate access revocation
  • HR offboarding workflows

🧩 Required Parameters

NameDescriptionExample
UPNThe user’s UPN"john.doe@contoso.com"
IssueKeyJira issue reference"ITSD-6001"

πŸͺ„ Optional Parameters

NameDescriptionExample
ForwardToSMTP address for mailbox forwarding"manager@contoso.com"

πŸ”§ What This Runbook Does

StepAction
1Reset AD password
2Remove all AD group memberships
3Disable AD account
4Revoke AzureAD sessions (Sign-out everywhere)
5Optional mailbox forwarding
6Logs every action
7Updates Jira with comment + transition

πŸ“€ Webhook JSON Example

{
  "customer": "Contoso",
  "runbook": "ACT-OffboardUser.ps1",
  "issue_key": "{{issue.key}}",
  "params": {
    "UPN": "{{issue.fields.customfield_10500}}",
    "ForwardTo": "{{issue.fields.customfield_10501}}",
    "IssueKey": "{{issue.key}}"
  }
}

πŸ“₯ Success Response

{
  "job_id": "job-off-8837",
  "status": "success",
  "output": "Offboarding completed successfully"
}

πŸ“₯ Error Response

{
  "job_id": "job-off-8837",
  "status": "error",
  "message": "Failed to disable account",
  "raw": "Disable-ADAccount : Access denied..."
}

πŸ—ƒ Requirements

  • Runner access to:
  • Domain Controller
  • Exchange PowerShell endpoint
  • Azure Graph or MSOnline API credentials for session revocation
  • AD & Exchange admin permissions
  • Customer config containing:
  • DomainController
  • ExchangeUri
  • MailDomain

πŸ— Version History

VersionDateChanges
1.02025-02-01Initial release
1.12025-02-03Added Azure session revocation
1.22025-02-04Added mailbox forwarding option