Introduction
OpsRamp provides you with the capability to build your integration using the Custom SSO Integration framework.
Custom SSO integration is configured between OpsRamp and your application if any third-party or other in-house applications are not present in the Available Integrations list.
SSO integration configuration involves your application and OpsRamp platform to configure redirects to your custom branding URL.
Prerequisites
- SAML EndPoints for HTTP
- x.509 Certificate (metadata XML file)
- Identity provider Issuer URL
- Logout URL
Configure Custom (SSO) integration
Follow these steps to configure Custom (SSO) integration:
Click All Clients, select a client.
Click Setup > Account.
Select the Integrations tile.
The Installed Integrations screen is displayed, with all the installed applications. Click + ADD on the Installed Integrations page.
If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations page displays all the available applications along with the newly created application with the version.
Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.Click +ADD on the Custom (SSO) tile.
Enter the following information in the Configuration screen:
CONFIGURE
Field Name Field Type Description Name String Enter a unique name for the integration. Description String Provide a description for the integration. Metadata XML File input Upload the XML file. This file will have all the information related to Issuer URL, Redirection URL, Logout URL, and Certificate.
After you upload the Metadata XML file, these fields are automatically populated.
Alternatively, you can enter the information in the fields manually.Issuer URL String Identity provider Issuer URL. Redirection URL String SAML EndPoints for HTTP. Logout URL String URL for logging out. Certificate String x.509 Certificate Provision Username as
There are two ways to provision a user. Select the appropriate option.Radio button Identify Provider's Name Identifier
option is selected by default. The user which is created in the SSO portal will reflect in OpsRamp.
Identify Provider's Name Identifier with OpsRamp tenant-unique prefix
This option allows you to:- Create usernames with a unique 3-digit alphanumeric prefix, that is generated automatically by the system.
- Install the same identity provider across multiple OpsRamp tenants.
Note: Once you enable this option and install the integration, you cannot revert your changes. Example: There are three partners, Partner P1, P2, and P3. Each partner has usernames created with unique 3-digit alphanumeric prefix, like g0z.username1 for partner P1, p0w.username1 for partner P2, and t9q.username1 for partner P3.
Click Next. The Inbound screen is displayed.
Click the edit icon and enter the following information:
USER PROVISION
Field Name Field Type Description Provision Type Dropdown If you select provision type as JIT, JIT user is created during user login. Default Role Dropdown The required user role. MAP ATTRIBUTES: Map the tenant entity attributes with OpsRamp entity.
Click +ADD and enter the following information in the ADD MAP ATTRIBUTES window:Note: The OpsRamp properties Primary Email, First Name, Last Name, and Role are required. Map the attributes for User and User Group accordingly.
Field Name Field Type Description OpsRamp Entity Dropdown Select OpsRamp entity from the dropdown. OpsRamp Property Dropdown Select OpsRamp property from the dropdown. It will change based on entity selection. CUSTOM-SSO Entity String Enter the Custom SSO Entity in the box. CUSTOM-SSO Property String Enter the Custom SSO Property in the box. PROPERTY VALUES: Click +PROPERTY VALUE. Enter the following information and click SAVE:
Note: This section is displayed based on the OpsRamp Entity and OpsRamp Property selected.Field Name Field Type Description CUSTOM-SSO Property Value String Enter custom SSO property value in the box. OpsRamp Property Value Dropdown Select a value from the dropdown.
Based on the OpsRamp Property selected, the options in this field change.Click ADD MAP ATTRIBUTES. The mapped information is displayed in the MAP ATTRIBUTES section.
- Click +ADD to add additional map attributes.
- Use the three dots menu to edit or remove the map attributes.
- Use Filter to filter the map attributes.
Note: If Role is not configured in Map Attributes section, the Default Role provided in USER PROVISION section is considered for SSO.
Click FINISH. The custom SSO integration is installed and displayed under Installed Integrations.
Actions on Integration
You can perform actions like View Logs, Export, Edit, and Uninstall on the integration.
- See Actions on Integration for more information.
Audit Logs
View Inbound logs from the View Logs option for the integration. You can view if the event was successful or not.
See Audit Logs for more information.