Skip to content

Commit 00238f5

Browse files
committed
Merge branch 'feat/API-hub-migration-guide'
2 parents e6140a1 + 46ea4af commit 00238f5

File tree

5 files changed

+505
-396
lines changed

5 files changed

+505
-396
lines changed

website/docs/docs/faq.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
title: API Hub Migration Guide
3+
---
4+
5+
This guide helps you transition from PactFlow standalone to your API Hub account.
6+
7+
## Frequently Asked Questions
8+
9+
### Authentication
10+
11+
All users must log in through **SmartBear ID**.
12+
13+
After migration, you may see a **Continue with SmartBear ID** button, or you may be redirected directly to authenticate with SmartBear ID.
14+
15+
> **Note:** All users must have a SmartBear ID to log in to SmartBear products.
16+
17+
The sections below explain login changes in more detail.
18+
19+
#### I was using a username and password
20+
21+
If you haven't already created a SmartBear ID:
22+
23+
- Select **Continue with SmartBear ID** and register a new account.
24+
- Use the **same email** as your previous login.
25+
- You’ll retain all existing permissions after login.
26+
27+
> If you register after migration, it should still work as expected.
28+
29+
#### I was logging in via my company’s SSO (e.g. Azure AD or Okta)
30+
31+
After migration:
32+
33+
- You may see a **Continue with SmartBear ID** button.
34+
- When clicked, or if skipped, you'll be automatically redirected to your SSO provider.
35+
36+
#### I was using GitHub or Google login
37+
38+
GitHub and Google login is still supported, but the behavior has changed.
39+
40+
##### Previous behavior
41+
42+
- Available only to paid customers (Team and Enterprise).
43+
- Domain (Google) and organization (GitHub) restrictions were supported.
44+
- Users were auto-provisioned without explicit invites.
45+
46+
##### New behavior
47+
48+
- Available to **all plans**.
49+
- A new provider, **Microsoft**, will be supported.
50+
- **Users must be manually invited**. The email must match exactly.
51+
- **Domain/org restrictions are no longer supported** (feature deprecated).
52+
53+
> Existing users are not affected—they do not require re-inviting.
54+
55+
---
56+
57+
## Plan Details
58+
59+
### Will I be paying more?
60+
61+
No. You will be migrated to an API Hub plan at **the same price** you currently pay, with additional features included.
62+
63+
### What features should I expect?
64+
65+
#### PactFlow Enterprise Customers
66+
67+
- Migrated to **API Hub for Contract Testing (Enterprise)** plan.
68+
- Receive **Team-level** entitlements for Design, Test, Explore, and Portal features.
69+
70+
#### PactFlow eCommerce Customers
71+
72+
- Migrated to **API Hub for Contract Testing (Team)** plan.
73+
- Receive **Individual-level** entitlements for the other API Hub features.
74+
75+
---
76+
77+
## Deprecated Features and Breaking Changes
78+
79+
### API and Terraform Client
80+
81+
- Updates to Google/GitHub login settings will no longer take effect.
82+
- `disable user` has been deprecated. The `active` field is ignored, but Terraform usage remains compatible.
83+
- `Invite User API` is not supported for API Hub accounts.
84+
85+
---
86+
87+
## New Features
88+
89+
### New Login URL
90+
91+
You can now log in using:
92+
93+
```
94+
https://app.pactflow.io
95+
```
96+
97+
- This new URL is a central entry point for all users.
98+
- After login, users are either:
99+
- Directed to their default tenant, or
100+
- Presented with a list of organisations they belong to.
101+
102+
> Your existing tenant-specific URL (e.g., `xyz.pactflow.io`) will continue to work.
103+
104+
### Website and Marketing Collateral
105+
106+
- Update all links to use the new URL above.
107+
- The phrase “PactFlow Contract Testing Platform” can be removed from external collateral.
108+
- A **Login** button can be added to your homepage.
109+
110+
---
111+
112+
## User and Org Management
113+
114+
- Managing users is no longer done within the PactFlow UI.
115+
- All user management is now performed in the [SmartBear Admin Portal](https://support.smartbear.com/swaggerhub/docs/admin/manage-users.html).
116+
117+
![SmartBear Admin](/ui/apihub/migration-smartbear-admin.png)
118+
119+
---
120+
121+
## API Hub Product Switching
122+
123+
Some UI updates are included as part of the transition:
124+
125+
- New **product switcher** experience.
126+
- Updated branding and navigation reflecting **API Hub** instead of PactFlow.
127+
128+
![Product Switcher](/ui/apihub/migration-product-switcher.png)

0 commit comments

Comments
 (0)