Sherweb
The Sherweb integration connects CIPP to your Sherweb CSP account so that Microsoft 365 licences and subscriptions can be managed from within CIPP. Once configured and mapped, you can purchase licences while creating users, adjust subscription quantities from the CSP Licenses report, schedule decreases to land at renewal, and optionally automate migrations from a legacy CSP.
Prerequisites
You need an active Sherweb partner account with access to the Cumulus portal, and API access enabled on that account. Three values are collected from Sherweb and entered into CIPP.
Obtaining Your API Credentials
Configuring the Integration in CIPP
Settings
Enable Integration
Turns the integration on. Every other setting, the Test button, and the Tenant Mapping tab remain unavailable until this is enabled and saved.
Client ID
The Client ID of the application created in the Sherweb Cumulus portal.
Subscription Key
The subscription key used to access the Sherweb API.
Client Secret
The client secret used to authenticate the application. Stored securely and masked once saved.
Select CIPP roles that are allowed to purchase licenses
Restricts subscription changes to CIPP users holding one of the selected custom roles. Leave empty to allow anyone with the relevant CIPP permission.
Enable automated migration to Sherweb
Reveals the automated migration options described below.
Select how you'd like automated migrations to be handled
The migration strategy: notify only, buy and notify, or buy and cancel.
Select the vendor to automatically migrate from
The legacy CSP whose subscriptions should be cancelled. Only appears for the buy and cancel strategy, and currently only supports Pax8.
Select the type of license to automatically migrate to
The commitment term for licences purchased at Sherweb: Yearly (Y1Y), Annual paid monthly (M1Y), or Monthly (M2M). Appears for any strategy that purchases.
Pax8 Client ID
The Client ID of your Pax8 API application. Only appears when migrating from Pax8.
Pax8 Client Secret
The client secret of your Pax8 API application. Only appears when migrating from Pax8.
Tenant Mapping
The Tenant Mapping tab pairs each CIPP tenant with a Sherweb customer, so CIPP knows which Sherweb account to place orders against. Licence purchasing and automated migrations both depend on this, and an unmapped tenant is simply skipped.
To map manually, choose a tenant, choose the matching entry under Select Sherweb Company, and select the add button. Automap Companies fills in matches automatically, and the refresh button reloads the customer list from Sherweb. Mappings are only written when you select Submit.
IntegrationName
The name of the Sherweb customer the tenant is mapped to.
Tenant
The display name of the mapped Microsoft 365 tenant.
TenantDomain
The default domain name of the mapped tenant.
TenantId
The tenant's Microsoft customer ID.
Individual mappings can be removed with the Delete Mapping row action.
Purchasing and Managing Licences
With the integration enabled and the tenant mapped, licence actions become available in several places.
When adding or editing a user, selecting a licence with no available seats reveals 0 Licences available. Purchase new licence?. Enabling it lets you pick a Sherweb License to buy, and CIPP assigns the licence to the user once it becomes available.
The Add Subscription page purchases a new subscription outright, and requires you to confirm that the purchase is made under your terms with Sherweb.
The CSP Licenses report carries row actions for existing subscriptions.
Increase licence count by 1
Adds a single seat to the subscription immediately.
Decrease licence count by 1
Removes a single seat from the subscription immediately.
Increase licence count
Adds a chosen number of seats to the subscription immediately.
Decrease licence count
Removes a chosen number of seats from the subscription immediately.
Schedule decrease of 1 at next renewal
Creates a scheduled task to remove a seat shortly before the subscription's renewal date, defaulting to three days beforehand.
Cancel Subscription
Cancels the subscription entirely.
Automated Migrations
Automated migrations identify licences at a non-Sherweb CSP that are approaching their transfer window. Depending on the strategy chosen, they notify you, purchase the equivalent licence at Sherweb, or additionally cancel the legacy subscription.
Once automated migrations are enabled, CIPP registers a daily background check for each mapped tenant. Each run looks for subscriptions renewing within the next seven days, compares them against the subscriptions already held at Sherweb, and treats anything without an equivalent as a candidate for migration. Turning the setting back off removes the background check as well, so no further alerts or purchases follow.
Choose a strategy
Under Select how you'd like automated migrations to be handled, choose one:
Notify only raises an alert when a subscription enters its cancellation window, and takes no other action.
Buy and notify purchases the matching Sherweb licence and alerts you.
Buy and cancel purchases the matching Sherweb licence and cancels the legacy subscription at the previous CSP.
Alerts are delivered by email, to your PSA, and by webhook, following your alert configuration. Purchases are matched to the Sherweb catalogue on the Microsoft SKU ID together with the commitment term you selected; if no catalogue entry matches, the purchase is not attempted and you receive a failure alert instead. Cancellation failures at Pax8 are alerted the same way, so a purchase that succeeds while the cancellation fails will not go unnoticed.
Feature Requests / Ideas
We value your feedback and ideas. Please raise any feature requests on GitHub.
Last updated
Was this helpful?

