Who can use this feature?
Workspace Owners, Super Admins, Admins, and Users
Only supported using the Cerby web app
As a user with any workspace role in Cerby, except Guest User and Login-Only, you can connect a business hub integration to centrally manage the users and assets of your seat-based and paid social apps.
When you connect the business hub, you become its Owner, and you can perform the following user and access management tasks from Cerby through automated tasks or API calls:
Check for updates
Add users
Update user roles
Remove users
TIP: For more details about the automated tasks of a business hub, how it works, and the supported apps, read the article Explore Business Hubs.
This article provides generic instructions on how to connect a business hub to Cerby. For app-specific articles and videos, visit the Connecting business hubs for your apps and Connecting business hubs for your paid social apps collections in the Cerby Help Center.
Requirements
The following are the requirements to connect a business hub:
A Cerby workspace
A Cerby user account with the workspace Owner, Super Admin, Admin, or User role
A collaboration space (workspace, team, or dashboard) in your app
A group assignment configured in your identity provider (IdP) if you want to leverage automatic user provisioning and deprovisioning for your apps based on IdP events. For more information, read the articles available in the Managing users via an IdP and business hub collection in the Cerby Help Center
An automation account, meaning an active user account with a native admin role in your seat-based or paid social app. For instructions and recommendations on how to create this account, read the article Create a service account for your business hub
The user management and login method for your business hub identified. For more information, read the User management and login method section of the article Explore Business Hubs
A business or organization ID. Commonly, you can find the ID in the following ways:
From the address bar: When you are logged in to your app, sometimes the ID is displayed in the address bar as part of the URL. For example,
https://business.app.com/settings/&business_id=1234567890. Just copy the value and paste it when connecting the business hub.From the business information or settings: When you are logged in to your app, navigate to the settings or business information page. The ID is usually displayed in an information section for you to copy.
NOTE: Not all business hubs require a business or organization ID; Cerby displays an input field when applicable to your app.
Connect a business hub for your app
To connect a business hub for your seat-based or paid social app, you must complete the following main steps from the Cerby web app dashboard:
The following sections describe each main step.
1. Add a business hub and connect it to your external app
To add a business hub and connect it to your seat-based or paid social app, you must complete the following steps:
Log in to your corresponding Cerby workspace.
Select the Business Hubs option from the left menu. The Business Hubs page is displayed.
Click the Connect Business Hub button located at the top right of the page. The Connect your Business Hubs to Cerby dialog box is displayed.
TIP: You can select the Don’t show this again option to skip this step the next time you connect a new business hub.Click the Get started button. A wizard is displayed on the Select app page.
Select the corresponding app from the catalog. The Enter app details page is displayed on the wizard.
Enter and select your app information in the corresponding fields:
Label in Cerby: It is the name to assign to your business hub in Cerby, and it will be displayed on the business hub card.
Business ID: It is the unique identifier of your business or organization within the seat-based or paid social app. This value may exist or not depending on the app and might have different names, such as Organization ID or Team ID. For generic instructions on how to find the ID, read the Requirements section.
User management and login method: It is the way your users log in to the app and determines if they must save their credentials in Cerby. You must select one of the following methods:
Single sign-on (SSO): Access is managed by your identity provider, and users log in with SSO authentication. They are not asked to save their credentials in Cerby.
Username and password: Account security and access are managed by Cerby, and users log in with their credentials after saving them in Cerby.
NOTE: Other input fields relevant to your app might be required.
Click the Next button. The Select automation account page is displayed. One of the following scenarios occurs:
If you already have an account for the external app, a list of accounts is displayed.
Select the corresponding automation account.
Click the Connect app button.
If you don’t have an account for the external app, you are prompted to add it:
Enter your account details in the corresponding fields:
Account label in Cerby: It is the name to assign to your account in Cerby, and it is displayed on the account card.
App: It is the name of the app or service provider to which the account belongs or the login URL.
NOTE: The app you selected in step 5 is displayed on this field, and you cannot change it.Username: It is the username you use to log in to your account. Sometimes, the username is your email address.
Current password: It is the password you use to log in to your account.
Phone Number Linked to Account: It is the phone number associated with your account
Click the Add account button.
The wizard closes, and a success message box is displayed. The corresponding business hub is also displayed on the Business Hubs page.
The next step is 2. Check for updates to import users, roles, and assets to Cerby.
2. Check for updates to import users, roles, and assets to Cerby
To check for updates in your app to identify and import users, roles, and assets to Cerby, you must complete the following steps:
Select the Business Hubs option from the left menu. The Business Hubs page is displayed.
Click the More options (
) icon of the corresponding business hub card. A drop-down menu is displayed.
Select the Settings option from the menu. The business hub details page is displayed with the Settings tab activated.
Click the Check for updates button located at the top right of the page. A message box is displayed with information about the process.
NOTE: The check and import process may take a few minutes depending on the number of users and assets, and because Cerby automatically matches users to their corresponding Cerby account.Confirm that the check for updates automated task has the “Completed” status by performing any of the following actions:
Click the More details button from the message box.
Select the Automation option from the left menu to open the Automation page.
NOTE: Cerby automatically performs daily checks for updates for all business hubs, but you can trigger them manually, as described above in steps 1 to 4. For more information, read the article Sync your app users with your business hub.
The next step is 3. Connect your external app user account to the business hub (optional).
3. Connect your external app user account to the business hub (optional)
As an integration Owner, you can access the external app using the service account associated with the business hub. However, to avoid potential conflicts and ensure smooth access, Cerby recommends connecting your external app user account to the business hub, especially if you actively work in the external app.
To connect your external app user account to the business hub so Cerby can manage and protect it, you must complete the following steps:
Select the Accounts option from the left menu. The Accounts page is displayed.
Click the Log in button of the corresponding business hub card. The Connect your <app name> Hub Account dialog box is displayed.
Enter the login credentials of your external app user account.
NOTE: If you have already added user accounts to Cerby, the dialog box displays these accounts on a list, and you must select one of them to connect it to the app.Click the Connect account button. The dialog box closes, and a success message box and a new account card for your user account are displayed.
The next step is 4. Manage unmatched users, which you must complete from your Cerby dashboard.
4. Manage unmatched users
After a check for updates, Cerby automatically matches app members to the Cerby user accounts that correspond to their email addresses, including existing guest users and local partners. Manual matching is required for external apps that don't provide email addresses and for app users using personal or external accounts that couldn’t be identified or are not in the corporate directory.
To view the status of the imported external app users, you must complete the following steps:
Select the Business Hubs option from the left menu. The Business Hubs page is displayed.
Click the More options (
) icon of the corresponding business hub card. A drop-down menu is displayed.
Select the View Members option from the menu. The business hub details page is displayed with the Members tab activated.
The app users are displayed in the following tabs of the User Overview section:Unmatched users: This tab displays the users who were not automatically matched because they use an email address that couldn’t be identified or they are not in the corporate directory.
Onboarded users: This tab displays the users matched to their Cerby user account.
Guest users: This tab displays the users who were matched to a user account that doesn’t exist in the corporate directory, such as external collaborators.
For unmatched users, you can perform one of the following actions:
The following sections describe each action.
Match users
To match users to their corresponding Cerby user account, you must complete the following steps from the Unmatched users tab of the business hub details page:
Click the Match user button of the corresponding user. The Match user dialog box is displayed.
Enter the Cerby username or email address of the user you want to match and invite in the Match with field. The user is displayed on a list.
Select the user from the list.
Click the Next button. The Select Cerby role dialog box is displayed.
Select the corresponding role of the user on the business hub integration from the Cerby role drop-down menu:
Owner: This role enables sharing access and managing the business hub integration settings in Cerby.
Collaborator: This role enables only logging in to the app through Cerby.
Click the Match user button. The dialog box closes, and a success message box is displayed. The user is moved to the Onboarded users tab.
Remove unmatched users
To remove unmatched users from the seat-based or paid social app, you must complete the following steps from the Unmatched users tab of the business hub details page:
IMPORTANT: When removing an unmatched user, Cerby performs an automated job to revoke the user’s seat and permissions in the external app. |
Click the More options (
) icon of the corresponding user. A drop-down menu is displayed.
Select the Remove user option from the menu. The Remove user? dialog box is displayed.
Click the Remove user button. The dialog box closes, and a success message box is displayed. The user is removed from the external app.
Exempt unmatched users
Exempted users keep their user accounts active for the seat-based or paid social app, but you cannot manage them through Cerby.
To exempt unmatched users, you must complete the following steps from the Unmatched users tab of the business hub details page
Click the More options (
) icon of the corresponding user. A drop-down menu is displayed.
Select the Exempt user option from the menu. The Exempt user dialog box is displayed.
Enter a reason for exempting the user in the Provide a reason field.
Click the Exempt member button. The dialog box closes, and a success message box is displayed. The user is moved to the Exempted users tab.
Use your business hub
The following are the supported features of business hubs you can use: