Connect CIPP
CIPP (the CyberDrain Improved Partner Portal) is an open-source multi-tenant Microsoft 365 management portal for MSPs. Connecting CIPP to StackJack gives your AI assistant tools for Microsoft 365…
Written By Christopher Scaminaci
Last updated 15 days ago
CIPP (the CyberDrain Improved Partner Portal) is an open-source multi-tenant Microsoft 365 management portal for MSPs. Connecting CIPP to StackJack gives your AI assistant tools for Microsoft 365 users, tenants, groups, Intune device management, Exchange mailboxes, transport rules, conditional access, security, and CIPP standards through StackJack's MCP endpoint. See the generated CIPP tool reference for the current inventory, input schemas, plan tiers, and safety notes. (MCP, the Model Context Protocol, is the open standard that lets AI assistants like Claude, ChatGPT, and Copilot call your MSP tools securely.)
CIPP authenticates through Azure AD (Entra ID) client credentials, so this connector needs more fields than most: six values, all of which CIPP generates for you on one page.
Before you begin
- You need the Owner, co-owner, or Administrator role in StackJack to configure connectors.
- You need access to your CIPP instance's Integrations area (the ability to create CIPP-API clients).
- You need your CIPP instance's default Azure App Service URL — the one ending in
.azurewebsites.net. StackJack cannot connect through a custom domain (see the warning below). - Connecting a connector automatically activates it on the Free plan. You can upgrade to a paid plan at any time from the Connectors page — current pricing is shown in the portal.
Tip: The same steps below are always available in-app — open Connectors, find the CIPP card, and click How To Connect.
Step 1: Create an API client in CIPP
- In your CIPP instance, go to CIPP > Integrations > CIPP-API to open the API configuration page.
- Click Actions > Create New Client. Enter an app name (for example,
StackJack). - Enable the client. For least privilege, use Custom Roles to limit the API endpoints this client can call. Select only the read or write operations your StackJack workflows need.
- Optional: use Allowed IP Ranges to restrict the client to individual IPv4 or IPv6 addresses or CIDR ranges. Do this only after StackJack support gives you the current outbound addresses for your environment; guessing can lock the connector out.
- Submit the client and copy its Application Secret immediately to a secure temporary location.
- Click Actions > Save Azure Configuration so CIPP applies the API-client configuration to Azure. Wait for the page to refresh with the remaining values.
- Leave this page open — you'll copy six fields from it: API URL, Client ID, Secret, API Scope, Token URL, and Tenant ID.
CIPP's human portal roles and an API client's Custom Roles are separate permission systems. Do not assign broad human-role names on the assumption that they describe the API-client boundary.
Step 2: Add the credentials to StackJack
In the StackJack portal, go to Connectors and click Configure on the CIPP card.
Fill in the six fields, copying each from the CIPP API page:
Click Save.
StackJack cross-checks your entries before saving and stops with a specific warning if something doesn't line up:
- The Instance URL must end in
.azurewebsites.net. - If you filled in a Token URL, the tenant inside it must match the Azure AD Tenant ID field. If they differ, fix one of them — or clear the Token URL to auto-derive it.
- If you filled in an API Scope, it must reference the Application ID. If it doesn't, correct it — or clear the API Scope to auto-derive it.
When you later re-open the dialog on a connected CIPP card, the stored Tenant ID, API Scope, and Token URL are re-loaded for editing; the Application Secret is never re-displayed.
What happens when you save
- Your credentials are stored encrypted in Azure Key Vault. They are never stored in StackJack's database.
- StackJack immediately test-calls CIPP to validate the credentials. CIPP validation can take up to a minute — CIPP runs on Azure Functions, and a cold instance needs time to wake up. Don't close the page early.
- If validation fails or times out, your credentials are still saved and you'll see a warning — validation retries automatically in the background.
- A Free plan subscription for CIPP is activated automatically if you don't already have one.
- If validation keeps failing (three consecutive definitive failures), StackJack auto-disables the connection, emails the tenant owner, and shows Re-enable and Update Credentials buttons on the card.
What the Exchange Online tools can and cannot change
- Reading Exchange settings:
cipp_list_exo_requestruns any read-only Exchange Online command (theGet-commands) for one tenant. - There is no "run any Exchange change" tool. CIPP does not offer one: its Exchange command endpoint accepts read commands only. Changes go through the named tools below.
- Groups, including distribution lists and mail-enabled security groups:
cipp_manage_group_membersadds or removes members and owners by email address, user name or object ID. Name the group itself by its object ID; a distribution list or mail-enabled security group can also be named by its email address.cipp_add_group,cipp_edit_groupandcipp_delete_groupcover the rest of the group lifecycle. - Spam, malware, anti-phishing and Safe Attachments rules: create, turn on or off, or remove inbound spam filters, and turn malware, anti-phishing and Safe Attachments rules on or off.
- DKIM, mailbox auditing, the unified audit log, and policy settings (malware, anti-phishing, outbound spam): CIPP applies these through its standards. Save a standards template for the tenant with
cipp_add_standards_template, then apply it withcipp_standards_run. The template stays in CIPP afterwards; remove it withcipp_remove_standard_templateif you do not want to keep it. Your CIPP API client needs theTenant.Standards.ReadWritepermission for these two calls, which CIPP's built-in editor role does not include. - SPF and DMARC are DNS records at your domain's DNS host. Microsoft 365 cannot change them;
cipp_list_domain_healthreads them. - Microsoft Graph reads:
cipp_graph_requestcalls the Graph beta API unless you passversionv1.0. Some paths exist on only one version (for example/groupSettingsis v1.0 only; beta calls it/settings). To narrow a list, pass the OData options as their own arguments:filter,select,expand,top,count,orderBy,searchandnoPagination. CIPP applies each one. An option written inside the endpoint path is not applied.topis a page size, not a limit: CIPP still follows every page unless you also passnoPaginationas true. For example, sign-in events for one user are/auditLogs/signInswith afilteronuserPrincipalNameandcreatedDateTime,top50 andnoPaginationtrue. - Converting a mailbox:
cipp_convert_mailboxtakes CIPP's four mailbox types:Shared,Regular(a user mailbox),RoomorEquipment. The Exchange namesSharedMailbox,UserMailbox,RoomMailboxandEquipmentMailboxwork too. To convert a departing user's mailbox to Shared,cipp_offboard_userwith onlyconvertToSharedset does the same and nothing else. - Each tool needs the matching permission on your CIPP API client. Group membership changes need
Identity.Group.ReadWrite.
Checking an offboarding
cipp_offboard_useranswers as soon as CIPP has queued the work. To see what each step did, runcipp_offboarding_job_statuswith theDeploymentIdfrom that answer. This needs a CIPP release from September 2026 or later.- A scheduled offboard returns no
DeploymentId. Runcipp_offboarding_job_statuswith the user's UPN instead; it lists the user's offboarding tasks. Your CIPP API client needsCIPP.Scheduler.Readfor that. - License removal runs as its own task about five minutes after the offboarding, so a license result that is missing right after the run is still pending.
cipp_list_scheduled_itemscan filter by tenant, task name, state, command or reference.
Investigating a business email compromise
These tools use the BEC investigation that CIPP added at the end of September 2026. On an older CIPP instance the new tools fail with "Endpoint not found".
cipp_bec_checkstarts a full investigation of one user and answers a case id (GUID). Pass the user's object ID, not the UPN. Call it again with that value asguidto poll: the answer is progress while the run works, an error if it failed, and the findings when it is done. Every start queues a new run and stores a case in CIPP.cipp_list_bec_reportslists the stored cases; pass the user's object ID to see only that user's. Use it before you start another run.cipp_delete_bec_reportdeletes a case for good.cipp_bec_evidence_exportreturns a short-lived download link to a ZIP of the case's findings, containment history and report PDFs. It needs a completed case.cipp_list_bec_phishing_spreadshows who else received mail from one sender in the last 1 to 90 days.cipp_list_bec_remediation_actionslists the containment actions.cipp_bec_remediateruns them: passactionsand the case id ascaseId. WithoutactionsCIPP runs its default set, which includes a password reset and blocking the sign-in. CIPP refuses any set that holds a Critical action unlessconfirmationis the user's UPN. The reply holds one row per action: read each row'sstate, because one action can fail while the call still answers success. A password reset row shows the new password, so treat the reply as a secret.cipp_bec_bulk_checkstarts an investigation for each of several users of one tenant (pass object IDs). Each one is a full run. If CIPP cannot find some of the IDs, the reply still comes back normally: read theCasesin it (an entry with a case id was queued, one with an error was not) and retry only the IDs that failed. If none of the IDs can be found, the call is an error.cipp_bec_report_pdfreturns a short-lived download link to the PDF report of a completed case (variantfullorsummary). It never starts an investigation.cipp_list_bec_remediation_defaultsshows which containment actions run by default, andcipp_set_bec_remediation_defaultsreplaces that set. The set applies to every tenant on your CIPP instance and to CIPP's own automation, so changing it can make a password reset or a sign-in block run without anyone confirming it. Both need the CIPP roleCIPP.AppSettings.ReadWrite, which CIPP's built-in readonly and editor roles do not include.- The built-in agent template CIPP BEC Triage Preflight runs this flow for you: it finds the tenant and the user, starts the investigation (or reuses a case that is still in progress or completed in the last 24 hours), reads sign-in logs, mailbox rules and conditional access, and checks the case a bounded number of times. An investigation can outlast one run: run the template again later and it reuses the same case and links the PDF summary report once the case has completed. It starts an investigation in CIPP and changes nothing else.
cipp_bec_ip_reviewre-judges a completed case's IP addresses with your verdicts (Safe, Suspicious or Compromised) and answers aDeploymentId; follow it withcipp_offboarding_job_status. It changes the case only, not the tenant.- API client roles:
cipp_list_bec_remediation_actionsneedsIdentity.User.ReadWritealthough it only reads, andcipp_list_bec_remediation_defaultsneedsCIPP.AppSettings.ReadWrite. The other reads needIdentity.User.Read.
Microsoft Purview tools
The CIPP connector can read and manage Microsoft Purview in your customers' tenants: sensitivity labels and the policies that publish them, data loss prevention (DLP) policies and rules, retention policies and retention labels, custom sensitive information types, and Communication Compliance policies (read only). These tools use features CIPP added in CIPP 10.5.0, and the custom sensitive information type tools need CIPP 10.6.0 or later. On an older CIPP instance they fail, or for sensitive information types do the wrong thing, until CIPP is updated. The retention policy list shows each policy's rules and real scope only on a current CIPP release.
Before you use them:
- API client roles. If your CIPP API client uses a custom role, add the roles for the tools you want:
Security.SensitivityLabel.Readand.ReadWrite,Security.DlpCompliancePolicy.Readand.ReadWrite,Security.RetentionCompliancePolicy.Readand.ReadWrite,Security.SensitiveInfoType.Readand.ReadWrite, andCIPP.Core.Readfor the label policy, DLP rule, retention label and Communication Compliance lists. - Customer tenants. CIPP runs these commands in each customer tenant through its own access. Retention commands run as CIPP's app, so apply CIPP's SAM roles to the tenant first. A tenant without Microsoft Purview licensing returns an error.
- Reading results. When a change fails, CIPP answers with an HTTP error even if the cause is not a permission or an
outage (a duplicate name, for example), so read the message. Current CIPP releases answer HTTP 500; older ones answered
HTTP 403. The deploy tools always answer with success at the HTTP level: read each tenant's line in
Results. - Settings CIPP does not deploy. The DLP and sensitivity label deploy tools pass on only the settings CIPP supports;
CIPP drops any other setting without an error. Each tool's description lists what CIPP keeps. Settings it drops
include DLP encryption and password-protected-document rules (set those in the Microsoft Purview portal) and a
label's external sharing and Teams settings (set those afterwards with
cipp_edit_sensitivity_label). A DLP deploy that fails part-way can leave the policy and some rules created, so check withcipp_list_dlp_rules. - Which policies publish a label. The label list's
PublishedInPoliciesfield is filled in by CIPP and currently comes back empty even for published labels. Usecipp_list_sensitivity_label_policiesto see which policies publish which labels. - Deploy means create or update. Deploying a label, DLP policy, retention policy or sensitive information type whose name already exists in a tenant updates the existing one. For a sensitive information type that shares a rule package with other types, the update can replace the whole package, so check the package first.
What these tools cannot do, because neither CIPP nor Microsoft offers a way:
- Create or change Insider Risk Management policies. Microsoft offers no API for them. Insider Risk alerts are available on the Microsoft Graph connector.
- Create or change Communication Compliance policies. Microsoft does not support managing them from PowerShell.
- Delete a single DLP rule or a sensitivity label policy. Disable the rule by deploying the policy again with the rule marked disabled, or use the Microsoft Purview portal.
Troubleshooting
Rotating the application secret
In CIPP > Integrations > CIPP-API, open the client's row menu and choose Reset Application Secret. Copy the replacement immediately, then use Update Credentials on the StackJack connector card and run Re-test. Plan the change as a coordinated rotation: the old secret stops working after CIPP resets it.
Disconnecting
Click Disconnect on the CIPP card to delete the stored credentials from Key Vault. Any AI tools using the connector stop working immediately.
⚠ Disconnecting does not cancel a paid plan — billing continues until you cancel it separately. The plan controls only appear while the connector is connected, so end the plan before disconnecting. On a paid connector that button reads Manage on Billing and opens this connector's removal dialog on the Billing page; a legacy website subscription still reads Cancel Plan. If you've already disconnected, save your credentials again to bring the plan controls back, then end the plan.
CIPP tools
cipp_ · 473 tools · Free 194 · Pro 279
Tenants
Users
User Management
Groups
Mailboxes
Mailbox Management
Mailbox Retention
Contacts & Resources
Transport & Spam
Devices
Device Management
Security
Conditional Access
Safe Links
Purview Sensitivity Labels
Purview DLP
Purview Retention
Purview Sensitive Information Types
Purview Communication Compliance
Teams & SharePoint
Standards
Audit
GDAP
Scheduler
Utility
Diagnostics
Analytics
Application Approvals
Applications
Was this helpful?
More in Connector guides
Connect 3CXConnect AbleSignConnect Acronis Cyber Protect CloudConnect Action1Still need help? Ask the team