mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-24 21:11:53 +00:00
docs(msp): align guides with current portal behavior
Correct customer, session, role, branding, and lifecycle guidance to match the current Partner Portal implementation.
This commit is contained in:
Alan Buscaglia
@@ -15,7 +15,7 @@ The console is available at [partners.prowler.com](https://partners.prowler.com)
|
||||
* **Delegated access:** open any customer's Prowler Cloud tenant from the console. Every action is attributed to you acting on behalf of that customer.
|
||||
* **Team and roles:** invite team members by email and assign a role that governs what they can do.
|
||||
* **Consolidated billing:** each customer carries its own plan, with month-to-date revenue reported across every customer.
|
||||
* **Branding:** upload your logo to appear alongside Prowler branding in the console.
|
||||
* **Branding:** upload your logo and preview its intended placement in Settings.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
@@ -35,7 +35,7 @@ Three objects make up the model. Getting these straight makes the rest of the do
|
||||
| **Console** | [cloud.prowler.com](https://cloud.prowler.com) | [partners.prowler.com](https://partners.prowler.com) |
|
||||
| **Scope** | One organization's own cloud accounts | Many customer organizations |
|
||||
| **Billing** | Each organization pays for itself | The provider manages a plan per customer |
|
||||
| **Branding** | Prowler-branded | Your logo alongside Prowler branding |
|
||||
| **Branding** | Prowler-branded | Logo upload and placement preview in Settings |
|
||||
|
||||
Your customers keep signing in to Prowler Cloud with their own users. Provider-side access is **additive** — it does not replace or restrict customer-side users.
|
||||
|
||||
@@ -46,7 +46,7 @@ Signing in lands you on the **Dashboard**. The sidebar carries:
|
||||
| Entry | What it does | Visible to |
|
||||
|---|---|---|
|
||||
| **Dashboard** | Partner Insights, a Billing Overview card and an Active Customers table | Everyone |
|
||||
| **Customers** | Add customers, review their posture and billing, and open their Prowler Cloud tenant | Everyone |
|
||||
| **Customers** | Review customer posture and billing and open customer tenants; Superadmins can also add customers | Everyone |
|
||||
| **Team** | Invite, re-invite, disable and remove team members | Roles with **Manage members** |
|
||||
| **Settings** | Profile, Partner Code, branding and security | Everyone; editing requires **Manage settings** |
|
||||
|
||||
@@ -54,7 +54,7 @@ Signing in lands you on the **Dashboard**. The sidebar carries:
|
||||
|
||||
**Partner Insights** is the top row: **Total Customers**, broken down into active and non-paid; **Cloud Accounts**, broken down by cloud provider; and **Monitored Resources**, with a note on organizations whose critical risk has grown. Each card carries a 30-day trend.
|
||||
|
||||
Below it, **Billing Overview** reports monthly expenses against the previous month and splits revenue for the period into annual, monthly and overage. **Active Customers** lists your customers with their provider count, resource count and last completed scan, and carries its own **Add Customer** button.
|
||||
Below it, **Billing Overview** reports monthly expenses against the previous month and splits revenue for the period into annual, monthly and overage. **Active Customers** lists your customers with their provider count, resource count and last completed scan and, for Superadmins, carries its own **Add Customer** button.
|
||||
|
||||
## Getting Access
|
||||
|
||||
|
||||
@@ -31,9 +31,9 @@ The **Change Plan** dialog opens on **Choose your plan**, with the same **Monthl
|
||||
|
||||
|
||||
|
||||
Select a plan and confirm with **Change Plan**. Choosing the annual plan also asks for the upfront provider account count. The change is submitted to Prowler Cloud and applied asynchronously; the customer's row updates once it lands. If it fails, a message explains why:
|
||||
Select a plan and confirm with **Change Plan**. Choosing the annual plan also asks for the upfront provider account count. The change is submitted to Prowler Cloud and applied asynchronously; the customer's row updates once it lands. If it fails, use the reported problem to identify the cause:
|
||||
|
||||
| Message | Cause |
|
||||
| Problem | Cause |
|
||||
|---|---|
|
||||
| Cloud accounts count is required | The annual plan was selected without a provider account count. |
|
||||
| Cloud accounts count out of range | The count is outside 1–20. |
|
||||
|
||||
@@ -3,11 +3,11 @@ title: "Customizing Your Branding in Prowler for MSPs and MSSPs"
|
||||
sidebarTitle: "Branding"
|
||||
---
|
||||
|
||||
Upload your company logo to have it displayed alongside Prowler branding in the console. Branding is managed from **Settings → Branding** and requires a role with **Manage settings**.
|
||||
Upload and save your company logo, then preview its intended placement alongside Prowler branding. Branding is managed from **Settings → Branding** and requires a role with **Manage settings**.
|
||||
|
||||
## Upload a Logo
|
||||
|
||||
Open **Settings → Branding**, click **Upload Logo**, and pick your file. The logo replaces the placeholder immediately and a confirmation appears.
|
||||
Open **Settings → Branding**, click **Upload Logo**, and pick your file. The logo replaces the placeholder in Settings immediately and a confirmation appears.
|
||||
|
||||
|
||||
|
||||
@@ -36,24 +36,16 @@ Uploaded SVG files are sanitized on the server. Scripts, external references and
|
||||
|
||||
## Replace or Remove a Logo
|
||||
|
||||
Uploading a new file replaces the current one. **Remove Logo** deletes it and returns the console to the default Prowler branding. Both take effect immediately for everyone on your team.
|
||||
Uploading a new file replaces the saved logo. **Remove Logo** deletes it and returns the Settings preview to the *Your Logo* placeholder.
|
||||
|
||||
## Logo Placement Preview
|
||||
|
||||
Below the upload controls, **Logo Placement Preview** renders your logo underneath the Prowler wordmark, showing how the two are intended to sit together in a Prowler Cloud organization. With no logo uploaded, the slot shows a *Your Logo* placeholder.
|
||||
Below the upload controls, **Logo Placement Preview** renders your logo underneath the Prowler wordmark to show the intended placement. With no logo uploaded, the slot shows a *Your Logo* placeholder.
|
||||
|
||||
<Note>
|
||||
The preview is rendered locally in the console. Uploading a logo does not currently push it to Prowler Cloud.
|
||||
The saved logo is currently displayed only in the upload area and placement preview on this Settings page. It is not applied elsewhere in Partner Portal, Prowler Cloud or customer reports.
|
||||
</Note>
|
||||
|
||||
## Where Your Logo Appears
|
||||
|
||||
Your logo is shown alongside Prowler branding within the console for your team.
|
||||
|
||||
<Warning>
|
||||
**Branding does not extend to Prowler Cloud.** Customers signing in at [cloud.prowler.com](https://cloud.prowler.com) see the standard Prowler interface. White-labeling Prowler Cloud is not supported.
|
||||
</Warning>
|
||||
|
||||
## Next Steps
|
||||
|
||||
<Columns cols={2}>
|
||||
|
||||
@@ -10,7 +10,7 @@ Adding a customer in Prowler for MSPs and MSSPs provisions a Prowler Cloud tenan
|
||||
Select **Customers** in the sidebar, then click **Add Customer** to open a three-step wizard.
|
||||
|
||||
<Note>
|
||||
Adding a customer is restricted to the Superadmin role. Organization Admins manage existing customers but do not see the **Add Customer** button.
|
||||
In the Partner Portal UI, the **Add Customer** action is currently shown to Superadmins. Organization Admins manage existing customers but do not see the action.
|
||||
</Note>
|
||||
|
||||
<Steps>
|
||||
@@ -27,13 +27,13 @@ Adding a customer is restricted to the Superadmin role. Organization Admins mana
|
||||
</Step>
|
||||
|
||||
<Step title="Launch Their Customer Workspace">
|
||||
A banner confirms the outcome — created on trial, or subscribed to a paid plan — and the tenant is created and linked to your organization. Click **Go To Organization** to head straight there and start connecting cloud providers, or **Close** to return to the customer list.
|
||||
Wait while the tenant is created and linked to your organization. A banner then confirms that the customer was created on trial or that paid-plan enrollment was submitted. Click **Go To Organization** to head straight there and start connecting cloud providers, or **Close** to return to the customer list.
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
Provisioning is asynchronous. The customer's row shows **Provisioning** until the tenant is ready, then switches to **Active**.
|
||||
Customer creation waits for tenant provisioning to finish. A successful submission adds the customer as **Active**. If you selected a paid plan, enrollment continues asynchronously and the billing status updates when it completes.
|
||||
|
||||
## The Customers View
|
||||
|
||||
@@ -53,11 +53,9 @@ Each row carries:
|
||||
| **Billing Type** | The customer's current plan, shown as **Trial**, **Pro Monthly** or **Pro Annual** |
|
||||
| **MTD** | Month-to-date spend |
|
||||
| **Last Month Expenses** | Previous month's total |
|
||||
| **Status** | **Active**, **Provisioning** or **Inactive** |
|
||||
| **Status** | The customer's current status |
|
||||
| **Last scan completed** | When the most recent scan finished |
|
||||
|
||||
A customer shows as **Provisioning** while its tenant is being created, and **Inactive** once it has been marked for removal.
|
||||
|
||||
Above the table, search by name and filter by provider or status. The download button at the top right of the table exports the list.
|
||||
|
||||
## Open a Customer's Prowler Cloud Tenant
|
||||
@@ -88,10 +86,6 @@ The customer-side flow that consumes the Partner Code is rolling out progressive
|
||||
|
||||
Your customers keep signing in to [cloud.prowler.com](https://cloud.prowler.com) with their own users. Your access is additive — it neither replaces nor restricts theirs.
|
||||
|
||||
## Remove a Customer
|
||||
|
||||
Removing a customer detaches it from your partner organization and moves it to **Inactive**. It does not delete the customer's data in Prowler Cloud; contact Prowler to arrange the offboarding of the tenant itself.
|
||||
|
||||
## Next Steps
|
||||
|
||||
<Columns cols={2}>
|
||||
|
||||
@@ -20,9 +20,9 @@ A rejection email carries the reason, categorized as **Incomplete documentation*
|
||||
|
||||
## Settings
|
||||
|
||||
Open **Settings** from the sidebar. The page has three tabs — **Profile**, **Branding** and **Security** — though what you can do in them depends on your role.
|
||||
Open **Settings** from the sidebar. The tabs depend on your role. Users with **Manage settings** see **Profile**, **Branding**, **Security** and a disabled **Notifications** tab. Users without **Manage settings** see only **Security**.
|
||||
|
||||
Every signed-in user can view the settings and change their own password. Editing the organization itself requires a role with **Manage settings**; without it, only the **Security** tab is available.
|
||||
Every signed-in user can change their own password. Editing the organization itself requires a role with **Manage settings**.
|
||||
|
||||
### Profile
|
||||
|
||||
@@ -39,7 +39,7 @@ Upload your logo. See [Customizing Your Branding](/user-guide/tutorials/prowler-
|
||||
|
||||
### Security
|
||||
|
||||
Change your own password. Roles with **Manage settings** — Superadmin today — also reach the Danger zone described below. An Organization Admin sees the password form only.
|
||||
Change your own password. Users with **Manage settings** can also see the Danger zone described below, but only the partner owner can submit a deletion request. An Organization Admin sees the password form only.
|
||||
|
||||
## Customer Capacity
|
||||
|
||||
@@ -51,11 +51,11 @@ Deleting a partner organization is a request, not an immediate action.
|
||||
|
||||
<Steps>
|
||||
<Step title="Open the Danger zone">
|
||||
Go to **Settings → Security**. The Danger zone and its **Delete Partner** action require a role with **Manage settings**.
|
||||
Go to **Settings → Security**. The Danger zone requires **Manage settings**, and submitting its **Delete Partner** request is restricted to the partner owner.
|
||||
</Step>
|
||||
|
||||
<Step title="File the request">
|
||||
Optionally give a reason in **Reason for deletion**, then type `DELETE` in the confirmation field to enable the button and submit.
|
||||
Enter a required **Reason for deletion**. The UI accepts 10–1000 characters, and the API rejects reasons shorter than 10 characters. Then type `DELETE` in the confirmation field to enable the button and submit.
|
||||
</Step>
|
||||
|
||||
<Step title="Wait for review">
|
||||
@@ -73,7 +73,7 @@ Closing a partner organization does not delete customer data in Prowler Cloud on
|
||||
|
||||
## Ownership
|
||||
|
||||
One user is the **owner** of the partner organization — by default, whoever signed up. Ownership can be transferred to another team member, who keeps the Superadmin role. The owner cannot be removed from the team while they hold ownership.
|
||||
One user is the **owner** of the partner organization — by default, whoever signed up. Ownership transfer is Prowler-assisted rather than self-service: contact Prowler to request it. Prowler staff can transfer ownership only when the partner has no customer organizations and the target is an active Superadmin. The previous owner keeps the Superadmin role, and the current owner cannot be removed from the team while they hold ownership.
|
||||
|
||||
## Next Steps
|
||||
|
||||
|
||||
@@ -41,11 +41,10 @@ Every password in the console — at sign-up, when accepting an invitation, and
|
||||
| **Number** | At least 1 digit |
|
||||
| **Special character** | At least 1 special character |
|
||||
| **Not common** | Rejected if it appears on the common-password list |
|
||||
| **Not similar to your details** | Rejected if too close to your name or email |
|
||||
|
||||
## Sign In
|
||||
|
||||
Sign in at [partners.prowler.com](https://partners.prowler.com) with your email and password, then click **Login**. Select **Remember me** to keep the session alive longer between visits.
|
||||
Sign in at [partners.prowler.com](https://partners.prowler.com) with your email and password, then click **Login**.
|
||||
|
||||
|
||||
|
||||
@@ -68,9 +67,9 @@ The confirmation banner appears whether or not the email matches an account, so
|
||||
|
||||
## Sessions
|
||||
|
||||
Access tokens are short-lived — **30 minutes** by default — and refresh automatically while you are active. The refresh window is **24 hours**, extended to **7 days** when you select **Remember me**. Refresh tokens rotate on every refresh and the previous one is revoked.
|
||||
Portal sessions currently use a sliding **23-hour** lifetime. Continued use may renew the session window, but you should expect to sign in again after extended inactivity. Selecting **Remember me** does not provide a seven-day Portal session.
|
||||
|
||||
If a refresh fails — after long inactivity, a revoked token, or a server restart — you return to the sign-in screen with a `RefreshAccessTokenError` notice. Sign in again to continue.
|
||||
If session refresh or validation fails, you are redirected to the sign-in screen. Sign in again to continue.
|
||||
|
||||
## Sign Out
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ Each role is a set of permission flags:
|
||||
| **Manage members** | Invite, re-invite, disable, enable and remove team members | ✓ | |
|
||||
| **Manage settings** | Edit the organization profile and branding | ✓ | |
|
||||
| **Manage billing** | Manage customer plans | ✓ | ✓ |
|
||||
| **Manage organizations** | Remove customers and edit their details | ✓ | ✓ |
|
||||
| **Manage organizations** | Edit existing customer details | ✓ | ✓ |
|
||||
| **Access tenants** | Open a customer's Prowler Cloud tenant | ✓ | ✓ |
|
||||
|
||||
<Note>
|
||||
@@ -40,7 +40,7 @@ The Prowler Cloud-side permission level for a team member is provisioned automat
|
||||
</Step>
|
||||
|
||||
<Step title="Track the invitation">
|
||||
The team table lists **Name**, **Email**, **Role**, **Status** and **User Event**. An invitation is **Pending**, **Accepted**, **Expired** or **Revoked**.
|
||||
The team table lists **Name**, **Email**, **Role**, **Status** and **User Event** for members and pending invitations. A pending invitation may display as **Expired** after its expiry passes. Accepted invitations become member rows, while revoked invitations are no longer shown.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user