Edit

Register a client application for the DICOM service

  • Article

In this article, you learn how to register a client application for the DICOM® service. You can find more information on Register an application with the Microsoft identity platform.

Register a new application

  1. In the Azure portal, select Microsoft Entra ID.

  2. Select App registrations.

    Screenshot that shows new app registration window.

  3. Select New registration.

  4. For Supported account types, select Accounts in this organizational directory only. Leave the other options as is.

    Screenshot that shows new registration account options.

  5. Select Register.

Application ID (client ID)

After you register a new application, you can find the Application (client) ID and Directory (tenant) ID from the Overview menu option. Make a note of the values for use later.

Screenshot that shows the client ID Overview pane.

Authentication setting: Confidential vs. public

Select Authentication to review the settings. The default value for Allow public client flows is No.

If you keep this default value, the application registration is a confidential client application and a certificate or secret is required.

Screenshot that shows confidential client application.

If you change the default value to Yes for the Allow public client flows option in the Advanced setting, the application registration is a public client application and a certificate or secret isn't required. The Yes value is useful when you want to use the client application in your mobile app or a JavaScript app where you don't want to store any secrets.

For tools that require a redirect URL, select Add a platform to configure the platform.

Note

For Postman, select Mobile and desktop applications. Enter https://www.getpostman.com/oauth2/callback in the Custom redirect URIs section. Select Configure to save the setting.

Screenshot that shows configuring other services.

Certificates & secrets

Select Certificates & secrets and select New client secret.

Add and then copy the secret value.

Screenshot that shows the Certificates & secrets pane.

Optionally, you can upload a certificate (public key) and use the Certificate ID, a GUID value associated with the certificate. For testing purposes, you can create a self-signed certificate using tools such as the PowerShell command line, New-SelfSignedCertificate, and then export the certificate from the certificate store.

API permissions

The following steps are required for the DICOM service. In addition, user access permissions or role assignments for Azure Health Data Services are managed through role-based access control (RBAC). For more information, see Configure Azure RBAC for Azure Health Data Services.

  1. Select the API permissions pane.

    Screenshot that shows the API permissions page with the Add a permission button highlighted.

  2. Select Add a permission.

    Add a permission to the DICOM service by searching for Azure API for DICOM under APIs my organization uses.

    Screenshot that shows the Search API permissions page with the APIs my organization uses tab selected.

    The search result for Azure API for DICOM only returns if you've already deployed the DICOM service in the workspace.

    If you're referencing a different resource application, select your DICOM API resource application registration that you created previously under APIs my organization uses.

  3. Select scopes (permissions) that the confidential client application asks for on behalf of a user. Select Dicom.ReadWrite, and then select Add permissions.

    Screenshot that shows scopes (permissions) that the client application asks for on behalf of a user.

Your application registration is now finished.

Note

DICOM® is the registered trademark of the National Electrical Manufacturers Association for its Standards publications relating to digital communications of medical information.