Who can use this feature?
Workspace Owners, Super Admins, and Admins
Only supported using the Cerby web app
As workspace Owner, Super Admin, or Admin, you can create an integration to connect your disconnected apps to your identity provider (IdP) through Cerby’s Identity Lifecycle Management (IdLCM) solution.
With IdLCM, you're setting up a SCIM gateway that translates SCIM requests from your IdP into actions for an external app. The IdLCM integration acts as a middle layer that receives, translates, and automates the execution of tasks such as the following:
User provisioning and deprovisioning
Asset management
Groups management
Sync app
This article provides generic instructions on how to create an IdLCM integration for your app.
Requirements
The following are the requirements to create an IdLCM integration:
A Cerby workspace
A Cerby user account with the workspace Owner, Super Admin, or Admin role
A collaboration space (workspace, team, or dashboard) in your app
A service account added to Cerby that corresponds to an active user account with a native admin role in your app. For instructions and recommendations on how to create this account, read the article Create a service account for your IdLCM integration.
The user management and login method for your integration must be identified. Depending on your app, the options might be the following:
Username and password
Single sign-on (SSO) with your IdP
Access token
A business or organization ID. Commonly, you can find the ID in the following ways:
From the address bar: After you logged in to your app, sometimes the ID is displayed in the address bar as part of the URL, either in the subdomain, path, or an ID parameter. For example:
123456890 in
https://business.app.com/settings/&business_id=1234567890contentzilla in
https://contentzilla.app.com/
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 IdLCM integrations require a business or organization ID; Cerby displays an input field when applicable to your app.
Create an IdLCM integration for your app
To create an IdLCM integration for your app, you must complete the following main steps:
The following sections describe each main step.
1. Create and set up an IdLCM integration in Cerby
To create and set up an IdLCM integration in Cerby, you must complete the following steps:
Log in to your Cerby workspace.
Select the Integrations option from the left menu. The Integrations page is displayed.
Click the Create integration button located at the top right of the page. The New app integration page is displayed.
Enter the corresponding information in the following fields of the Select app section:
Name: It is the name to assign to your integration in Cerby.
Select app: It is the name of the external app. The apps from Cerby’s catalog that match the name are displayed on a list automatically for you to select one.
IMPORTANT: You can only create an IdLCM integration if the app is in Cerby’s catalog.Business ID or other identifier: It is the unique identifier of your business or organization within the app. This field is displayed or not depending on the app, and it might have different names, such as Organization ID or Team ID. For generic instructions on how to find the ID, read the Requirements section.
Click the Next button. The Service account section is displayed.
Specify the service account and its login method by completing the following steps:
Select the login method of your service account from the options in the Select login workflow section. A list of accounts saved in Cerby for your external app is displayed below.
IMPORTANT: Currently, Cerby only supports username and password as the login method. If no accounts are displayed below, verify that you have created the service account and added it to Cerby, as detailed in the Requirements section.Select the service account from the list below.
Click the Next button. The Settings (Optional) section is displayed.
Click the Skip button. The Advanced settings (Optional) is displayed.
NOTE: The Settings (Optional) section is currently in development. By skipping it, the integration is created with default settings.(Optional) Specify the user schema configuration if you have custom roles:
Select the User schema option. The User schema side drawer is displayed.
Update the user schema to configure any custom roles or fields Cerby must consider.
NOTE: For instructions and recommendations on how to update the user schema, read the article Configure your user schema.Click the Save button. The side drawer closes.
Click the Test and save button located at the top right of the page. The Checking your integration setup… page is displayed.
Cerby starts an automation job to validate the settings and the provided service account. The page closes, and a success message box is displayed.
The next step is 2. Create and set up an app integration in your IdP connected to IdLCM, which you must complete in your IdP.
2. Create and set up an app integration in your IdP connected to IdLCM
To set up an app integration in your IdP connected to IdLCM, refer to the specific instructions for your IdP. Currently, we only support Okta, so follow the instructions in the article Create and set up an app integration in Okta connected to IdLCM.
The next step is 3. Sync users, roles, and entitlements from your external app to Cerby.
3. Sync users, roles, and entitlements from your external app to Cerby
After setting up the app integration in your IdP, you must sync the users, roles, and entitlements from your external app to Cerby. The goal is to import this data to match the current state of the app so you can start managing identities and access through IdLCM.
To sync the users, roles, and entitlements to Cerby, you must complete the following steps from your Cerby web app dashboard:
Select the Integrations option from the left menu. The Integrations page is displayed.
Click the More options (
) icon of the corresponding integrations. A drop-down menu is displayed.
Select the Settings option from the menu. The integrations details page is displayed with the Settings tab activated.
Click the Sync button located at the top right of the page.
NOTE: The check and import may take a few minutes, depending on the number of users. When the process is complete, a success message box is displayed.
4. Import users, roles, and entitlements from an IdLCM integration into your IdP
With the users, roles, and entitlements of your external app synced in Cerby, you must now import this data from the IdLCM integration to your IdP. The goal is to match the current state of the app and the IdLCM integration so you can centralize identity and access management in your IdP.
To import the users, roles, and entitlements to your IdP, refer to the specific instructions for your IdP. Currently, we only support Okta, so follow the instructions in the article Import users, roles, and entitlements from an IdLCM integration into Okta.