Edit

Secure an input constrained device by using Azure Active Directory (Azure AD) and Azure Maps REST APIs

  • Article

This guide discusses how to secure public applications or devices that can't securely store secrets or accept browser input. These types of applications fall under the internet of things (IoT) category. Examples include Smart TVs and sensor data emitting applications.

To view your Azure Maps account authentication details in the Azure portal:

  1. Sign in to the Azure portal.

  2. Navigate to the Azure portal menu. Select All resources, and then select your Azure Maps account.

  3. Under Settings in the left pane, select Authentication.

    Authentication details.

Three values are created when the Azure Maps account is created. They're used to support two types of authentication in Azure Maps:

  • Azure Active Directory Authentication: The Client ID represents the account that is to be used for REST API requests. The Client ID value should be stored in application configuration, and then it should be retrieved before making Azure Maps HTTP requests that use Azure AD authentication.
  • Shared Key Authentication: The Primary Key and Secondary Key are used as the subscription key for Shared Key authentication. Shared Key authentication relies on passing the key generated by the Azure Maps account with each request to Azure Maps. We recommend that you regularly regenerate your keys. To maintain current connections during regeneration, two keys are provided. One key can be in use, while regenerating the other. When you regenerate your keys, you must update any applications that access this account to use the new keys. For more information, see Authentication with Azure Maps

Create an application registration in Azure AD

Note

Create the device based application in Azure AD to enable Azure AD sign-in, which is granted access to Azure Maps REST APIs.

  1. In the Azure portal, in the list of Azure services, select Azure Active Directory > App registrations > New registration.

    A screenshot showing application registration in Azure AD

  2. Enter a Name, choose Accounts in this organizational directory only as the Supported account type. In Redirect URIs, specify Public client / native (mobile & desktop) then add https://login.microsoftonline.com/common/oauth2/nativeclient to the value. For more information, see Azure AD Desktop app that calls web APIs: App registration. Then Register the application.

    A screenshot showing the settings used to register an application.

  3. Navigate to Authentication and enable Treat application as a public client to enable device code authentication with Azure AD.

    A screenshot showing the advanced settings used to specify treating the application as a public client.

  4. To assign delegated API permissions to Azure Maps, go to the application. Then select API permissions > Add a permission. Under APIs my organization uses, search for and select Azure Maps.

    A screenshot showing where you request API permissions.

  5. Select the check box next to Access Azure Maps, and then select Add permissions.

    A screenshot showing where you specify the app permissions you require.

  6. Configure Azure role-based access control (Azure RBAC) for users or groups. For more information, see Grant role-based access for users to Azure Maps.

  7. Add code for acquiring token flow in the application, for implementation details see Device code flow. When acquiring tokens, reference the scope: user_impersonation that was selected on earlier steps.

    Tip

    Use Microsoft Authentication Library (MSAL) to acquire access tokens. For more information, see Desktop app that calls web APIs: Code configuration in the active directory documentation.

  8. Compose the HTTP request with the acquired token from Azure AD, and sent request with a valid HTTP client.

Sample request

Here's a sample request body for uploading a simple Geofence represented as a circle geometry using a center point and a radius.

POST /mapData?api-version=2.0&dataFormat=geojson
Host: us.atlas.microsoft.com
x-ms-client-id: 30d7cc….9f55
Authorization: Bearer eyJ0e….HNIVN

The following sample request body is in GeoJSON:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

Sample response header

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Grant role-based access for users to Azure Maps

You can grant Azure role-based access control (Azure RBAC) by assigning an Azure AD group or security principal to one or more Azure Maps role definitions.

To view the available Azure role definitions for Azure Maps, see View built-in Azure Maps role definitions.

For detailed steps about how to assign an available Azure Maps role to the created managed identity or the service principal, see Assign Azure roles using the Azure portal

To efficiently manage the Azure Maps app and resource access of a large amount of users, see Azure AD Groups.

Important

For users to be allowed to authenticate to an application, the users must first be created in Azure AD. For more information, see Add or delete users using Azure AD.

To learn about how to effectively manage a large directory for users, see Azure AD.

Warning

Azure Maps built-in role definitions provide a very large authorization access to many Azure Maps REST APIs. To restrict APIs access to a minimum, see create a custom role definition and assign the system-assigned identity to the custom role definition. This enables the least privilege necessary for the application to access Azure Maps.

Next steps

Find the API usage metrics for your Azure Maps account:

View usage metrics