Register Outlook Adaptive Cards for eShare

Prev Next

This document describes the steps to register Outlook Adaptive Cards for use with eSHARE. The registration is required for organizations who want to provide their internal users Outlook Actionable Message Adaptive Cards for replying to Secure Conversations. The following steps will be reviewed:

PREREQUISITES:

The person performing these steps must have an administrator role assignment of Application Administrator and Exchange Administrator, or Global Administrator in the destination M365 tenant.

Register the Application

  1. Sign in to the Microsoft Entra admin center (https://entra.microsoft.com or https://entra.microsoft.us).

  2. Navigate to 'Entra ID' > 'Applications' > 'App Registrations'.

  3. Select the '+ New registration' button in the top left of the page.

  4. Enter a display name for the application (ex. eSHARE Actionable Emails).

  5. Specify the Support Account Type as 'Accounts in this organizational directory only - Single tenant'.

  6. Leave the redirect URI blank.

  7. Select the 'Register' button and wait for the app to be created.

  8. Make note of the app's Application ID for future steps.

Note:

This application will not need any API permissions added or consented for.

Register an Actionable Message Provider

  1. Sign in to the Actionable Email Developer Dashboard (https://outlook.office.com/connectors/oam/publish). If the first link does not work, please visit Microsoft’s updated link: https://outlook.cloud.microsoft/actionablemessage/oam.

  2. Select the '+ New Provider' button in the top left of the page.

  3. Enter the following information in the registration window:

    1. Friendly name - Enter a name for the provider; it is suggested to name it the same as the App Registration.

    2. MsEntra Application Id - Add the App Registration’s Application ID.

    3. Sender email address from which actionable emails will originate - Add 2 email addresses: no-reply@yourdomain.com, notifications@yourdomain.com (ex. no-reply@eshare.com, notifications@eshare.com).

    4. Target Domains - Add 2 URL addresses: https://www.ncryptedcloud.com/api/3.1/adaptive-cards/messages and https://vanity.yourdomain.com/api/3.1/adaptive-cards/messages (ex. https://secure.bank2trust.com/api/3.1/adaptive-cards/messages).

    5. Public Key - Enter the public key provided by your eSHARE Customer Success Manager.

    6. Scope - For this use case it is recommended to select 'Organization'.

  4. Accept the terms and conditions and select 'Register the Provider' to submit the request.

  1. As an Exchange Administrator or Global Administrator, navigate to https://outlook.cloud.microsoft/actionablemessage/oam/admin or click on the Admin Dashboard.

  2. Select the newly created provider, which will be in PendingApproval state.

  3. Make note of the 'Provider Id (originator)' and 'App ID Uri' values for later steps.

  4. Select Approved as the new status from the dropdown and update the status.

  5. Lastly, send the 'Provider Id (originator)' value to your eSHARE CSM, and save the 'App Id Uri' somewhere, as it will be required in the next section.

Expose an API and Pre-Authorize eSHARE Actionable Messages

  1. Go back to the Entra ID admin center and open the previously created Application Registration.

  2. Navigate to 'Manage' > 'Expose an API', and select 'Edit' next to the Application ID URI text box.

  3. Paste the saved 'App Id Uri' in the Application ID URI text box, then select 'Save'.

  1. Under the 'Scopes defined by this API' section, select '+ Add a scope'.

  2. Fill in the following information in the 'Add a scope' pop-out screen:

    1. Scope name - Provide a name for the scope (ex. Global.test).

    2. Who can consent? - It is recommended to select 'Admins only'.

    3. Admin consent display name - Provide a display name of the API only Admins will see.

    4. Admin consent description - Provide a description of the API only Admins will see.

    5. User consent display name - Provide a display name of the API only Users will see.

    6. User consent description - Provide a description of the API only Users will see.

    7. State - Ensure it is enabled.

  3. Select the 'Add scope' button to save the information.

  1. Under the 'Authorized client applications' section, select '+ Add a client application'.

  2. Insert the string below in the Client ID field, and select the scope created in the previous step.

48af08dc-f6d2-435f-b2a7-069abd99c086
  1. Select the 'Add application' button to save the changes.

  1. The API is now exposed and Adaptive Cards are now ready to be used in eSHARE.

Note:

To utilize Outlook Actionable Message Adaptive Cards with eSHARE, the setting must be enabled in the Admin Console. Please refer to the following guide for more information.