Azure AD uses cross-domain Identity Management (SCIM) and Security Assertion Markup Language (SAML2.0). SCIM uses REST APIs to communicate between Azure AD and OpsRamp. The SCIM schema is used to handle end-to-end user management such as creating, updating, and deleting user accounts.

Prerequisites

  • Register with OpsRamp to get OpsRamp login credentials.
  • Your custom URL (such as <yourwebsitename>.opsramp.com).

Azure AD configuration

Azure AD configuration provides the SSO setting details that are required to configure OpsRamp.

  1. Log in to Azure AD.

  2. From the Azure AD console, select Azure Active Directory.

  3. From Default Directory, select Enterprise applications > All applications > +New application.

  4. Click Create your own application > Create your own application, provide a name, select the appropriate option, and click Create. For example, OpsRampSSO.

    Non-Gallery Application

    Non-Gallery Application

  5. From method as Single sign-on > SAML, enter the following settings in the Set up section:

    • Identifier: Custom branding URL in OpsRamp. The URL in each case is formed from the custom branding configured in OpsRamp for the client or the standard partner URL appended with saml.do
      (For example, https://<OpsRamp Custom Brand URL>/saml.do)

    • Reply URL: https://<OpsRamp Custom Brand URL>/samlResponse.do (For example: https://azuread.opsramp.com/samlResponse.do)

    • User Identifier: user.userprincipalname

  6. Copy the following information required for OpsRamp configuration:

    • Login URL
    • Azure AD Identifier
    • Logout URL

  7. Click Download on Certificate (Base64) field. The certificate is required for OpsRamp configuration.

  8. From the SAML Signing Certificate screen, right-click the certificate name and select Make Certificate active from the certificate drop-down option, if the Status is Inactive.

  9. Enter the following details and click Save:

    • Signing Option: Sign SAML Response and assertion
    • Signing Algorithm: SHA-256

  10. Click Provisioning from the left hand navigation pane and click Get Started from the screen, and specify:

    • Provisioning Mode: Automatic
    Provisioning mode

    Provisioning mode

    The Admin Credentials pane is displayed.

    • Admin Credentials: Enter Tenant URL and Secret Token (These settings are copied from the OpsRamp configuration steps.)
    Admin Credentials

    Admin Credentials

    Provisioning screen

    Provisioning screen

    • Click Test Connection to validate the Token settings. After validating the token settings, click Save. The Mappings and Settings pane are automatically populated.

    • Mappings: Mappings allow you to define how user data should flow between Azure Active Directory and OpsRamp. For more information on how to manage mappings, click here.

    • Settings: Notification Email: Valid email address to receive email notifications when a failure occurs. Scope: Set for synchronizing the user data. OpsRamp recommends to select Sync only assigned users and groups.

  11. Set the Provisioning Status to On. This is used to synchronize user data.

  12. Click Save to save the changes.

Users and Groups

The users and groups associated with the Azure AD Enterprise Application are synchronized with OpsRamp by the provisioning schedule.

Define Users and Groups and then add/assign these to the Enterprise Application.

In the below example, 2 groups have been defined and users assigned:

Groups are defined:

Users are assigned:

Note: The Group name can be used to assign the desired role in OpsRamp based on the Integration mapping.

The groups and users will be created in OpsRamp when provisioning occurs.

Provision a user

User Provisioning is an identity management process that ensures user accounts are created, given appropriate rights and permissions, modified, deleted, etc., to access an organization’s resources/applications.

To provision a user, follow the below steps:

After adding your application, on the Overview screen:

  1. Click Users and groups using the left hand navigation pane. The Users and groups screen is displayed showing the existing users/groups, if any.

  2. Click Add user/group. In Add Assignment screen, click None Selected under Users and groups. The Users and groups search window is displayed. Type the user name in the Search box and click Select. Note that only the first 50 search results are shown.

    Once you click Select, the Users and groups under Add Assignment shows the number of users selected.

  3. Click Assign. The user is assigned and displayed in the user/group list.

Provision a group

To provision a user group, follow the below steps:

After adding your application, on the Overview screen:

  1. Click Users and groups using the left hand navigation pane. The Users and groups screen is displayed showing the existing users/groups, if any.

  2. Click Add user/group. In Add Assignment screen, click None Selected under Users and groups. The Users and groups search window is displayed. Type the group name in the Search box and click Select. Note that only the first 50 search results are shown.

    Once you click Select, the Users and groups under Add Assignment shows the number of groups selected.

  3. Click Assign. The group is assigned and displayed in the user/group list.

Attribute Mapping

To map attributes (for users and groups), click the Provision Azure Active Directory Groups / Provision Azure Active Directory Users links from the Mappings pane. The Attribute Mapping screen is displayed. You can edit, add, or even delete an attribute mapping.

Edit:

To edit an attribute:

  1. Click on the attribute. The Edit Attribute popup is displayed. Select the Mapping type, Source attribute, Target attribute and other options as appropriate.

  2. Click Ok. The Attribute Mapping is saved.

Add:

To add an attribute:

  1. Click Add New Mapping link. Select the options and click Ok. The Attribute is saved and added to the list.

Delete:

To delete an attribute, simply click Delete. Then click Save to save the changes. Click Discard to undo the delete operation.

By default, Azure will have mappings which are not supported by OpsRamp, which will cause multiple updates in case of SCIM. Following mappings are supported by OpsRamp:

OpsRamp supports only the below mappings:

Azure Active Directory Attributecustomappsso AttributeOpsRamp Attribute
userPrincipalNameuserNameLogin Name
jobTitletitleDesignation
mailemails[type eq "work"].valuePrimary Email
givenNamename.givenNameFirst Name
surnamename.familyNameLast Name
streetAddressaddresses[type eq "work"].streetAddressAddress
cityaddresses[type eq "work"].localityCity
stateaddresses[type eq "work"].regionState
postalCodeaddresses[type eq "work"].postalCodeZipCode
countryaddresses[type eq "work"].countryCountry
mobilephoneNumbers[type eq "work"].valueMobile Number
telephoneNumberphoneNumbers[type eq "mobile"].valuePhone
otherMailsemails[type eq "home"].valueAlternate Email

OpsRamp configuration

OpsRamp configuration generates the URL and secret token that are required to complete configuration at Azure AD.
To configure SSO integration:

  1. From All Clients, select a client.

  2. Go to Setup > Integrations > Integrations.

  3. From Available Integrations, select SSO > Azure AD and click Install.

  4. Enter the following information in Install Azure AD Integration screen:

    Properties:

    • Issuer URL: Azure AD Identifier
    • Redirection URL: Login URL (SAML Single Sign-On Service URL)
    • Logout URL: Logout URL
    • Certificate: Certificate (Base64) The URL and certificate details are captured from the Azure AD configuration. Click Install. You can use the Browse button to select and then click Import to download the metadata file.

    User Provision:

    • Select the following details and click Save:
    • Provision Type: SCIM. When configuring the integration it is necessary to select the Provision Type - SCIM to synchronize users and groups when provisioning occurs. If you select provision type as JIT, JIT user is created during user login.
    • Default Role: The required user role.

  5. Copy the URL and Token information. These details are used when configuring Azure AD Provisioning settings.

  6. Define the following Map Attributes:

    Role mapping is required for groups and users.

    User:

    1. Select OpsRamp Entity as User and OpsRamp Property as Role.
    1. Click +. The Create User Mapping on Role popup is displayed.

    a. Third-party Entity: Enter the value.
    b. Third-party Property: Enter the value.
    OpsRamp Entity and OpsRamp Property are populated automatically.
    Under Add Property Values:
    c. Third-party Property Value: Enter the value that is coming from Azure side (from the payload).
    d. OpsRamp Property Value: Select the appropriate role corresponding to the Third-party Property Value. To add more property values click +.
    e. Click Save. The mapping is saved and displayed.

    User Group:

    1. Select OpsRamp Entity as User Group and OpsRamp Property as Role.
    1. Click +. The Create User Group Mapping on Role popup is displayed.

    a. Third-party Entity: Enter the value.
    b. Third-party Property: Enter the value.
    OpsRamp Entity and OpsRamp Property are populated automatically.
    Under Add Property Values:
    c. Third-party Property Value: Enter the value that is coming from Azure side (from the payload).
    d. OpsRamp Property Value: Select the appropriate role corresponding to the Third-party Property Value. To add more property values click +.
    e. Click Save. The mapping is saved and displayed.

Similarly, map attributes for other entities like First Name, Last Name, Mobile Number, Phone, Email, etc.

Synchronize with Azure AD

To synchronize with Azure AD, select Current Status > Refresh from the Azure AD Provisioning screen. Refresh executes a REST API call from Azure AD.

  • If the REST-defined user attributes match with the OpsRamp user attributes, the user information is updated in OpsRamp.
  • If the REST-defined user attributes do not match with the OpsRamp user attributes, those are matched when the attributes are defined in the OpsRamp Map Attributes step and updated.
  • If the REST-defined user attributes do not match with the defined Map Attributes, the API response fails, user synchronization fails, and the user is not created in OpsRamp. Azure AD displays the progress of synchronization and the result is displayed.

Users/Groups updated in OpsRamp after successful synchronization:

Limitations

  • Azure AD supports changing of login name, however, OpsRamp does not support changing of login name once a user is provisioned. Updating a login name in Azure AD causes the user to not be able to log in to OpsRamp.
  • OpsRamp does not support multiple role assignments for a user for SCIM provisioning. However, multiple roles are supported per JIT provisioning in Azure AD integration.