Integrating with Miro Enterprise

  • Release version: Xanadu
  • Updated August 1, 2024
  • 7 minutes to read

    • Integrating your Software Asset Management application with the Miro Enterprise application enables you to track your software subscriptions and to reclaim unused licenses.

    Important:
    Minimize security risks and protect information by granting access only to the necessary user or API permissions.
    Table 1. Minimal user permissions
    Process Required user role in the Miro Enterprise application Authentication scopes
    Download subscriptions Company admin organizations:read
    Pull user activity Company admin organizations:read
    Reclaim subscription Company admin None

    Create a Miro Enterprise OAuth 2.0 application

    Create a Miro Enterprise OAuth 2.0 application to enable access to the Miro API.

    Before you begin

    Miro Role required: Refer to the Minimal user permissions table.

    Procedure

    1. From a web browser, open the Miro Platform.
    2. If you have not created any teams within your organization or you want to build and test the OAuth 2.0 application using fake data, get a developer team.
    3. Sign in using your Company Admin credentials.
    4. On the page header of the Miro Platform, select the organization profile icon.
    5. On the side navigation panel, select Your Apps.
    6. Select Create a new app.
    7. In the Create new app dialog box, enter a name for the OAuth 2.0 application in the App Name field.
    8. Select the developer team for which you want to build the OAuth 2.0 application.
    9. Select Create app.
      The profile settings for your newly created app open.
    10. In the App Credentials section, copy the values in the Client ID and Client secret fields and save them in a secure location for later use.
    11. In the Redirect URI for OAuth 2.0 section, enter the URL of the OAuth provider that users are redirected to after authentication and then select Add.
      For example, https://instance.service-now.com/oauth_redirect.do, where <instance> is the name of your ServiceNow instance.
    12. In the Permissions section, select the organizations:read OAuth scope.
      OAuth scopes specify the level of access that the application has to your protected resources. The organizations:read OAuth scope enables your application to read information about your organization and organization members.
    13. Select Install app and get OAuth token.

    What to do next

    Keep your organization profile open so that you can enable SCIM (System for Cross-domain Identity Management) on your Miro Enterprise account. For more information, see Enable SCIM on your Miro Enterprise account.

    Enable SCIM on your Miro Enterprise account

    Enable SCIM (System for Cross-domain Identity Management) on your Miro Enterprise account so that you can generate an API access token for authenticating your Miro API requests.

    Before you begin

    Miro Role required: Refer to the Minimal user permissions table.

    Procedure

    1. On the left navigation pane of your Miro organization profile, select Security.
    2. On the Security page, select the option to Enable SSO/SAML.
    3. After SSO/SAML is enabled, select the option to enable SCIM Provisioning.
      Miro automatically generates and displays your API access token in the Api Token field.
    4. Optional: Select the Send email notifications to users provisioned by SCIM check box to enable Miro to send email notifications to all users that have been provisioned using SCIM.
    5. Copy the API access token in the Api Token field.
      Save it in a secure location for later use.

    Create a Miro Enterprise connection

    Create a connection between your Miro Enterprise applications and your ServiceNow instance.

    Before you begin

    ServiceNow Role required: admin

    Procedure

    1. From your ServiceNow instance, navigate to Process Automation > Flow Designer.
      The Flow Designer launches in a new tab.
    2. Select the Integrations tab and then search for Miro.
    3. Select View Details for your Miro Enterprise connection.
    4. From your Miro Enterprise connection details, select Configure.
    5. In the Create Connection dialog box, fill in the fields.
      Table 2. Create Connection dialog box
      Field Description
      Connection Information
      Connection Name Name of the Miro Enterprise connection. This field populates automatically.
      Credential Information
      OAuth Client ID Client ID that is assigned to your Miro Enterprise OAuth 2.0 application.
      OAuth Client Secret Client secret that is assigned to your Miro Enterprise OAuth 2.0 application.
      OAuth Redirect URL URL of the OAuth provider that users are redirected to after authentication.

      This field populates automatically based on the redirect URL that you specified in Create a Miro Enterprise OAuth 2.0 application.
    6. Select Create and Get OAuth Token.
      Important:

      This step must be executed by a ServiceNow admin with the Company Admin role in Miro.

    7. On the Miro OAuth authorization dialog box, locate the team that you built the Miro Enterprise OAuth 2.0 application for and then select Install.
      Note:
      If another ServiceNow instance is using the same credentials, you would be prompted for a reinstall.
      The OAuth access token becomes available for authorizing your Miro Enterprise connection.

    Create a Miro Enterprise SCIM connection

    Create a connection between the Miro Enterprise SCIM and your ServiceNow instance.

    Before you begin

    ServiceNow Role required: admin

    Procedure

    1. From your ServiceNow instance, navigate to Process Automation > Flow Designer.
      The Flow Designer launches in a new tab.
    2. Select the Integrations tab and then search for Miro.
    3. Select View Details for your Miro Enterprise SCIM connection.
    4. From your Miro Enterprise SCIM connection details, select Configure.
    5. In the Create Connection dialog box, fill in the fields.
      Table 3. Create Connection dialog box
      Field Description
      Connection Information
      Connection Name Name of the Miro Enterprise SCIM connection. This field populates automatically.
      Credential Information
      API Token API access token for authenticating Miro API requests.

      Enter the same API access token that you generated and copied in Enable SCIM on your Miro Enterprise account.
    6. Select Create Connection.

    Create a Miro Enterprise integration profile

    Create a Miro Enterprise integration profile to track software subscriptions and optimize licensing for your Miro Enterprise applications.

    Before you begin

    To create a Miro Enterprise integration profile, request the Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) from the ServiceNow Store.

    ServiceNow Role required: sam_integrator or admin

    About this task

    If you’re using Software Asset Workspace, the option to create the Miro Enterprise integration profile in Core UI is inactive.

    Procedure

    1. Navigate to the integration profile.
      InterfaceAction
      Core UI
      1. Navigate to All > Software Asset > SaaS License > Direct Integration Profiles.
      2. Select New.
      3. Select Miro Enterprise Integration Profile.
      Software Asset Workspace
      1. Navigate to License operations > User Subscriptions > Direct integration profiles.
      2. Select New.
      3. Select Miro Enterprise from the drop-down list.
      4. Select Continue.
    2. On the form, fill in the following fields.
      Table 4. Integration Profile form
      Field Description
      Display Name Name of the integration profile. For example, Miro Enterprise Integration.
      Status Status of the integration profile.
      • If you have not published the integration profile, this field is automatically set to Draft.
      • If you have already published the integration profile, this field is automatically set to Published.
      Profile Type Type of integration profile.

      This field is automatically set to Miro Enterprise Subscription.
    3. On the Download Subscription Subflow tab, verify that the Connection & Credential field is set to sn_miro_spoke.Miro_Enterprise and the Subflow field is set to Miro Download Subscriptions.
      You can view events performed by individual users up to one year prior to the current date. For more information, see Review a software reclamation rule.
      Note:
      Software Asset Management pulls the events from the time that you start downloading user subscriptions irrespective of the profile creation date.
    4. On the Reclaim Subscription Subflow tab, verify that the Connection & Credential field is set to sn_miro_spoke.Miro_Enterprise_SCIM and the Subflow field is set to Miro Reclaim Subscription.
    5. Select Save.
      Your ServiceNow instance creates a draft integration profile. The integration profile uses the Miro Download Subscriptions and Miro Reclaim Subscription subflows to retrieve user data from your Miro Enterprise applications.
    6. After the form reloads, select Publish.
      The Publish Confirmation dialog box opens.
    7. In the dialog box, select OK.

    What to do next

    After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and software subscriptions that are refreshed daily.

    If you want to set up multiple integration profiles with unique connections, create child aliases to manage different configurations and settings for each integration profile. For more information, see Create a child alias to set up multiple integration profiles.

    Review all automatically generated reclamation rules to reclaim user subscriptions. For more information, see Review a software reclamation rule.

    Create software entitlements for the automatically generated software models to track used software against owned software.
    Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench (Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance.