Skip to content

Commit 9a53e17

Browse files
Merge pull request #287963 from KendalBond007/APIforFHIRbatch10_Oct24
APIforFHIRbatch10_Oct24
2 parents 8a3ef00 + 61bf7fa commit 9a53e17

File tree

5 files changed

+43
-43
lines changed

5 files changed

+43
-43
lines changed

articles/healthcare-apis/azure-api-for-fhir/register-confidential-azure-ad-client-app.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ ms.author: kesheth
1111

1212
# Register a confidential client application in Microsoft Entra ID for Azure API for FHIR
1313

14-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
14+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1515

16-
In this tutorial, you'll learn how to register a confidential client application in Microsoft Entra ID.
16+
In this tutorial, you learn how to register a confidential client application in Microsoft Entra ID.
1717

18-
A client application registration is a Microsoft Entra representation of an application that can be used to authenticate on behalf of a user and request access to [resource applications](register-resource-azure-ad-client-app.md). A confidential client application is an application that can be trusted to hold a secret and present that secret when requesting access tokens. Examples of confidential applications are server-side applications.
18+
A client application registration is a Microsoft Entra representation of an application that can be used to authenticate on behalf of a user, and request access to [resource applications](register-resource-azure-ad-client-app.md). A confidential client application is an application that can be trusted to hold a secret and present that secret when requesting access tokens. Examples of confidential applications are server-side applications.
1919

20-
To register a new confidential client application, refer to the steps below.
20+
To register a new confidential client application, use the following steps.
2121

2222
## Register a new application
2323

@@ -41,10 +41,10 @@ To register a new confidential client application, refer to the steps below.
4141

4242
## API permissions
4343

44-
Permissions for Azure API for FHIR are managed through RBAC. For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
44+
Permissions for Azure API for FHIR are managed through role-based access control (RBAC). For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
4545

4646
>[!NOTE]
47-
>Use grant_type of client_credentials when trying to obtain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
47+
>Use a `grant_type` of `client_credentials` when trying to obtain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
4848
4949

5050
## Application secret
@@ -53,7 +53,7 @@ Permissions for Azure API for FHIR are managed through RBAC. For more details, v
5353

5454
:::image type="content" source="media/add-azure-active-directory/portal-aad-register-new-app-registration-confidential-client-secret.png" alt-text="Confidential client. Application Secret.":::
5555

56-
1. Enter a **Description** for the client secret. Select the **Expires** drop-down menu to choose an expiration time frame, and then click **Add**.
56+
1. Enter a **Description** for the client secret. Select the **Expires** drop-down menu to choose an expiration time frame, and then select **Add**.
5757

5858
:::image type="content" source="media/add-azure-active-directory/add-a-client-secret.png" alt-text="Add a client secret.":::
5959

@@ -66,9 +66,10 @@ Permissions for Azure API for FHIR are managed through RBAC. For more details, v
6666
6767
## Next steps
6868

69-
In this article, you were guided through the steps of how to register a confidential client application in the Microsoft Entra ID. You were also guided through the steps of how to add API permissions in Microsoft Entra ID for Azure API for FHIR. Lastly, you were shown how to create an application secret. Furthermore, you can learn how to access your FHIR server using Postman.
69+
In this article, you were guided through the steps of how to register a confidential client application in the Microsoft Entra ID. You were also guided through the steps of how to add API permissions in Microsoft Entra ID for Azure API for FHIR. Lastly, you were shown how to create an application secret.<br>
70+
You can also learn how to access your FHIR server using Postman.
7071

7172
>[!div class="nextstepaction"]
7273
>[Access the FHIR service using Postman](./../fhir/use-postman.md)
7374
74-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
75+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/register-public-azure-ad-client-app.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ ms.author: kesheth
1111

1212
# Register a public client application in Microsoft Entra ID for Azure API for FHIR
1313

14-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
14+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1515

16-
In this article, you'll learn how to register a public application in Microsoft Entra ID.
16+
In this article, you learn how to register a public application in Microsoft Entra ID.
1717

1818
Client application registrations are Microsoft Entra representations of applications that can authenticate and ask for API permissions on behalf of a user. Public clients are applications such as mobile applications and single page JavaScript applications that can't keep secrets confidential. The procedure is similar to [registering a confidential client](register-confidential-azure-ad-client-app.md), but since public clients can't be trusted to hold an application secret, there's no need to add one.
1919

20-
The quickstart provides general information about how to [register an application with the Microsoft identity platform](../../active-directory/develop/quickstart-register-app.md).
20+
This quickstart provides general information about how to [register an application with the Microsoft identity platform](../../active-directory/develop/quickstart-register-app.md).
2121

2222
## App registrations in Azure portal
2323

@@ -33,7 +33,7 @@ The quickstart provides general information about how to [register an applicatio
3333

3434
1. Give the application a display name.
3535

36-
2. Provide a reply URL. The reply URL is where authentication codes will be returned to the client application. You can add more reply URLs and edit existing ones later.
36+
2. Provide a reply URL. The reply URL is where authentication codes are returned to the client application. You can add more reply URLs and edit existing ones later.
3737

3838
![Azure portal. New public App Registration.](media/add-azure-active-directory/portal-aad-register-new-app-registration-pub-client-name.png)
3939

@@ -51,21 +51,21 @@ To configure your [desktop](../../active-directory/develop/scenario-desktop-app-
5151

5252
## API permissions
5353

54-
Permissions for Azure API for FHIR are managed through RBAC. For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
54+
Permissions for Azure API for FHIR are managed through role-based access control (RBAC). For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
5555

5656
>[!NOTE]
57-
>Use grant_type of client_credentials when trying to otain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
57+
>Use a `grant_type` of `client_credentials` when trying to obtain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
5858
5959
## Validate FHIR server authority
60-
If the application you registered in this article and your FHIR server are in the same Microsoft Entra tenant, you're good to proceed to the next steps.
60+
If the application you registered and your FHIR server are in the same Microsoft Entra tenant, you're good to proceed to the next steps.
6161

62-
If you configure your client application in a different Microsoft Entra tenant from your FHIR server, you'll need to update the **Authority**. In Azure API for FHIR, you do set the Authority under Settings --> Authentication. Set your Authority to ``https://login.microsoftonline.com/\<TENANT-ID>`.
62+
If you configure your client application in a different Microsoft Entra tenant from your FHIR server, you need to update the **Authority**. In Azure API for FHIR, you do set the Authority under **Settings** > **Authentication**. Set your Authority to `https://login.microsoftonline.com/\<TENANT-ID>`.
6363

6464
## Next steps
6565

66-
In this article, you've learned how to register a public client application in Microsoft Entra ID. Next, test access to your FHIR Server using Postman.
66+
In this article, you learned how to register a public client application in Microsoft Entra ID. Next, test access to your FHIR Server using Postman.
6767

6868
>[!div class="nextstepaction"]
6969
>[Access the FHIR service using Postman](./../fhir/use-postman.md)
7070
71-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
71+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/register-resource-azure-ad-client-app.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,21 @@ ms.custom: devx-tr2ck-azurepowershell
1313

1414
# Register a resource application in Microsoft Entra ID for Azure API for FHIR
1515

16-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
16+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1717

18-
In this article, you'll learn how to register a resource (or API) application in Microsoft Entra ID. A resource application is a Microsoft Entra representation of the FHIR server API itself and client applications can request access to the resource when authenticating. The resource application is also known as the *audience* in OAuth parlance.
18+
In this article, you learn how to register a resource (or API) application in Microsoft Entra ID. A resource application is a Microsoft Entra representation of the FHIR&reg; server API itself, and client applications can request access to the resource when authenticating. The resource application is also known as the *audience* in OAuth parlance.
1919

2020
## Azure API for FHIR
2121

2222
If you're using the Azure API for FHIR, a resource application is automatically created when you deploy the service. As long as you're using the Azure API for FHIR in the same Microsoft Entra tenant as you're deploying your application, you can skip this how-to-guide and instead deploy your Azure API for FHIR to get started.
2323

24-
If you're using a different Microsoft Entra tenant (not associated with your subscription), you can import the Azure API for FHIR resource application into your tenant with
25-
PowerShell:
24+
If you're using a different Microsoft Entra tenant (not associated with your subscription), you can use PowerShell to import the Azure API for FHIR resource application into your tenant.
2625

2726
```azurepowershell-interactive
2827
New-AzADServicePrincipal -ApplicationId 4f6778d8-5aef-43dc-a1ff-b073724b9495 -Role Contributor
2928
```
3029

31-
or you can use Azure CLI:
30+
Or you can use Azure CLI.
3231

3332
```azurecli-interactive
3433
az ad sp create --id 4f6778d8-5aef-43dc-a1ff-b073724b9495
@@ -40,9 +39,9 @@ If you're using the open source FHIR Server for Azure, follow the steps on the [
4039

4140
## Next steps
4241

43-
In this article, you've learned how to register a resource application in Microsoft Entra ID. Next, register your confidential client application.
42+
In this article, you learned how to register a resource application in Microsoft Entra ID. Next, register your confidential client application.
4443

4544
>[!div class="nextstepaction"]
4645
>[Register Confidential Client Application](register-confidential-azure-ad-client-app.md)
4746
48-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
47+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

articles/healthcare-apis/azure-api-for-fhir/register-service-azure-ad-client-app.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ ms.author: kesheth
1111

1212
# Register a service client application in Microsoft Entra ID for Azure API for FHIR
1313

14-
[!INCLUDE [retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
14+
[!INCLUDE[retirement banner](../includes/healthcare-apis-azure-api-fhir-retirement.md)]
1515

16-
In this article, you'll learn how to register a service client application in Microsoft Entra ID. Client application registrations are Microsoft Entra representations of applications that can be used to authenticate and obtain tokens. A service client is intended to be used by an application to obtain an access token without interactive authentication of a user. It will have certain application permissions and use an application secret (password) when obtaining access tokens.
16+
In this article, you learn how to register a service client application in Microsoft Entra ID. Client application registrations are Microsoft Entra representations of applications that can be used to authenticate and obtain tokens. A service client is intended to be used by an application to obtain an access token without interactive authentication of a user. It has certain application permissions and can use an application secret (password) when obtaining access tokens.
1717

1818
Follow these steps to create a new service client.
1919

@@ -35,10 +35,10 @@ Follow these steps to create a new service client.
3535

3636
## API permissions
3737

38-
Permissions for Azure API for FHIR are managed through RBAC. For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
38+
Permissions for Azure API for FHIR are managed through role-based access control (RBAC). For more details, visit [Configure Azure RBAC for FHIR](configure-azure-rbac.md).
3939

4040
>[!NOTE]
41-
>Use grant_type of client_credentials when trying to otain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
41+
>Use a `grant_type` of `client_credentials` when trying to otain an access token for Azure API for FHIR using tools such as Postman. For more details, visit [Testing the FHIR API on Azure API for FHIR](tutorial-web-app-test-postman.md).
4242
4343
## Application secret
4444

@@ -51,13 +51,13 @@ The service client needs a secret (password) to obtain a token.
5151

5252
3. Provide a description and duration of the secret (either one year, two years or never).
5353

54-
4. Once the secret has been generated, it will only be displayed once in the portal. Make a note of it and store in a secure location.
54+
4. Once the secret is generated, it will only be displayed once in the portal. Make a note of it and store it in a secure location.
5555

5656
## Next steps
5757

58-
In this article, you've learned how to register a service client application in Microsoft Entra ID. Next, test access to your FHIR server using Postman.
58+
In this article, you learned how to register a service client application in Microsoft Entra ID. Next, test access to your FHIR server using Postman.
5959

6060
>[!div class="nextstepaction"]
6161
>[Access the FHIR service using Postman](./../fhir/use-postman.md)
6262
63-
FHIR&#174; is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.
63+
[!INCLUDE[FHIR trademark statement](../includes/healthcare-apis-fhir-trademark.md)]

0 commit comments

Comments
 (0)