Skip to content

Commit bbac5ef

Browse files
committed
added diagrams to the entra quickstart
1 parent 13e66fa commit bbac5ef

File tree

3 files changed

+20
-19
lines changed

3 files changed

+20
-19
lines changed

articles/communication-services/quickstarts/identity/entra-id-authentication-integration.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Set up and exchange access tokens for Microsoft Entra ID users
2+
title: Set up and obtain access tokens for Microsoft Entra ID users
33
titleSuffix: An Azure Communication Services quickstart
44
description: Building client application providing access tokens for Microsoft Entra ID users
55
author: aigerimb
@@ -14,15 +14,15 @@ ms.reviewer: dominikme, dariac, sanchezjuan
1414
zone_pivot_groups: acs-js-csharp-java-python
1515
ms.custom: mode-other, devx-track-extended-java, devx-track-js, devx-track-python, has-azure-ad-ps-ref
1616
---
17-
# Quickstart: Set up and exchange access tokens for Microsoft Entra ID users
17+
# Quickstart: Set up and obtain access tokens for Microsoft Entra ID users
1818

1919
[!INCLUDE [Public Preview Disclaimer](../../includes/public-preview-include.md)]
2020

21-
This quickstart demonstrates how to use the Communication Services Common SDK along with Azure Identity SDK in a console application to authenticate a Microsoft Entra ID user, obtain an Entra ID user token, and automatically exchange it for an Azure Communication Services access token for Microsoft Entra ID user. The resulting Azure Communication Services access token allows you to integrate calling and chat features using the Communication Services Calling and Chat SDKs.
21+
This quickstart demonstrates how to use the Communication Services Common SDK along with Azure Identity SDK in a console application to authenticate a Microsoft Entra ID user, obtain an Azure Communication Services access token for Microsoft Entra ID user. The resulting Azure Communication Services access token allows you to integrate calling and chat features using the Communication Services Calling and Chat SDKs.
2222

2323
## Prerequisites
2424
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
25-
- An active Azure Communication Services resource and connection string. For more information, see [Create an Azure Communication Services resource](./create-communication-resource.md).
25+
- An active Azure Communication Services resource and endpoint URI. For more information, see [Create an Azure Communication Services resource](./create-communication-resource.md).
2626
- A Microsoft Entra ID instance. For more information, see [Microsoft Entra ID overview](./entra/fundamentals/whatis).
2727

2828
## Introduction
@@ -41,13 +41,13 @@ The Administrator role has extended permissions in Microsoft Entra ID. Members o
4141
1. The Contoso Administrator creates or selects an existing *application* in Microsoft Entra ID. The property *Supported account types* defines whether users from various tenants can authenticate to the application. The property *Redirect URI* redirects a successful authentication request to the Contoso *client application*.
4242
1. The Contoso Administrator adds required API permissions from Communication Services Clients application. For the all list of the permissions, see [Access tokens with Microsoft Entra ID](./identity-model.md#access-tokens-with-microsoft-entra-id).
4343
1. The Contoso Administrator allows public client flow for the application.
44-
1. The Contoso Administrator creates or selects existing communication services. The Contoso Administrator grants Fabrikam Entra ID users access to Contoso Azure Communication Services resource. Azure Communication Services Common SDK will be used for Microsoft Entra ID user authentication and in the background seamlessly exchange Microsoft Entra user tokens for Communication Services access token of Microsoft Entra ID user. For more information, see [Create and manage Communication Services resources](./create-communication-resource.md).
44+
1. The Contoso Administrator creates or selects existing communication services. The Contoso Administrator grants Fabrikam Entra ID users access to Contoso Azure Communication Services resource. Azure Communication Services Common SDK will be used for Microsoft Entra ID user authentication and in the background seamlessly obtain an Azure Communication Services access token for Microsoft Entra ID user. For more information, see [Create and manage Communication Services resources](./create-communication-resource.md).
4545
1. The Fabrikam Administrator grants required Communication Services Clients application API permissions to the Contoso application. This step is required if only Fabrikam Administrator can grant access to the application with the required permissions.
4646

4747
<a name='step-1-create-a-service-principal-for-acs-clients-application'></a>
4848

4949
### Step 1: Create a service principal for Azure Communication Services Clients application
50-
To enable the Contoso application to access Communication Services Clients application API permissions, the Contoso Administrator must create a service principal for Azure Communication Services Clients application in the Contoso Microsoft Entra ID tenant.
50+
To enable the Contoso application to access Azure Communication Services Clients application API permissions, the Contoso Administrator must create a service principal for Azure Communication Services Clients application in the Contoso Microsoft Entra ID tenant.
5151
The Contoso Administrator can create a service principal in Contoso tenant by one of the following methods:
5252

5353
- Use the [Microsoft Graph REST API](./graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0&tabs=http#request) to run the following request:
@@ -86,9 +86,9 @@ For more detailed information, see [Register an application with the Microsoft i
8686

8787
On the **Authentication** pane of your application, you can see a configured platform for *Public client/native(mobile & desktop)* with a redirect URI pointing to *http://localhost*. At the bottom of the pane, you'll see an *Allow public client flows* toggle control, which for this quickstart should be set to **Yes**.
8888

89-
### Step 4: Add Communication Services Clients permissions in the application
89+
### Step 4: Add Azure Communication Services Clients permissions in the application
9090

91-
The application must declare Communication Services Clients to have access to Azure Communication Services capabilities. Microsoft Entra ID user would be requesting a Microsoft Entra user token with these permissions.
91+
The application must declare Azure Communication Services Clients to have access to Azure Communication Services capabilities. Microsoft Entra ID user would be requesting a Microsoft Entra user token with these permissions.
9292

9393
1. Navigate to your Microsoft Entra app in the Azure portal and select **API permissions**
9494
1. Select **Add Permissions**
@@ -114,7 +114,7 @@ In the Azure portal follow these steps:
114114
4. In the **Principal type** select the correct value. In this scenario Contoso Admin provides access for a group from Fabrikam tenant and chooses **Group**.
115115
5. In the **Object ID** field, enter the object ID of the group from Fabrikam Microsoft Entra tenant.
116116
6. In the **Tenant ID** field, enter the tenant ID of the Fabrikam Microsoft Entra tenant.
117-
7. In the **Clien ID** field, enter the client ID of the application from [step 2](entra-id-authentication-integration.md#step-2-create-a-microsoft-entra-application-registration-or-select-a-microsoft-entra-application).
117+
7. In the **Client ID** field, enter the client ID of Contoso application from [step 2](entra-id-authentication-integration.md#step-2-create-a-microsoft-entra-application-registration-or-select-a-microsoft-entra-application).
118118
8. Click **Save and exit** to apply the changes.
119119

120120

@@ -137,7 +137,7 @@ To construct an Administrator consent URL, the Fabrikam Microsoft Entra Administ
137137
The service principal of the Contoso application in the Fabrikam tenant is created if consent is granted. The Fabrikam Administrator can review the consent in Microsoft Entra ID by doing the following steps:
138138

139139
1. Sign in to the Azure portal as an administrator.
140-
1. Go to Microsoft Entra ID.
140+
1. Go to **Microsoft Entra ID**.
141141
1. On the **Enterprise applications** pane, set the **Application type** filter to **All applications**.
142142
1. In the field for filtering the applications, enter the name of the Contoso application.
143143
1. Select **Apply**.
@@ -166,14 +166,14 @@ To provide access to the group, the Fabrikam Administrator does the following st
166166

167167
## Developer actions
168168

169-
The Contoso developer needs to set up the *client application* to authenticate users. In the client application, the developer creates a credential using Communication Common SDK along with Azure Identity SDK capable of authenticating users against the Microsoft Entra ID application and exchanging the Microsoft Entra user token for Azure Communication Services access token of Microsoft Entra ID user.
169+
The Contoso developer needs to set up the *client application* to authenticate users. In the client application, the developer creates a credential using Communication Common SDK along with any implementation of the `TokenCredential` from Azure Identity SDK capable of authenticating users against the Microsoft Entra ID application.
170170

171171
The developer's required actions are shown in following diagram:
172172

173-
![Diagram of developer actions to enable Azure Communication Services support for Microsoft Entra ID users.]()
173+
![Diagram of developer actions to enable Azure Communication Services support for Microsoft Entra ID users.](./media/entra-id/entra-id-developer-overview.svg)
174174

175-
1. The Contoso developer initialize any implementation of `TokenCredential` from Azure Identity SDK which is capable of obtaining a Microsoft Entra user token for the application that was created earlier by the Administrator.
176-
1. The Contoso developer initializes `AzureCommunicationTokenCredential` from Communication Services Common SDK with `TokenCredential` created in the step 1. The `AzureCommunicationTokenCredential` credential exchanges the incoming Microsoft Entra user token for the access token of Teams user seamlessly in the background.
175+
1. The Contoso developer initialize any implementation of `TokenCredential` from Azure Identity SDK which is capable of obtaining a Microsoft Entra user token for the application that was created earlier by the Contoso Administrator.
176+
1. The Contoso developer initializes `AzureCommunicationTokenCredential` from Communication Services Common SDK with `TokenCredential` created in the step 1. The `AzureCommunicationTokenCredential` obtains an Azure Communication Services access token for Microsoft Entra ID user seamlessly in the background.
177177

178178
> [!NOTE]
179179
> The following sections describe how to create `AzureCommunicationTokenCredential`.
@@ -187,12 +187,11 @@ The developer's required actions are shown in following diagram:
187187

188188
The user represents the Fabrikam users of the Contoso application. The user experience is shown in the following diagram:
189189

190-
![Diagram of user actions to enable Azure Communication Services support for Microsoft Entra ID users.]()
190+
![Diagram of user actions to enable Azure Communication Services support for Microsoft Entra ID users.](./media/entra-id/entra-id-user-overview.svg)
191191

192192
1. The Fabrikam user uses the Contoso *client application* and is prompted to authenticate.
193-
1. The Contoso *client application* uses the Azure Identity SDK to authenticate the user against the Fabrikam Microsoft Entra tenant for the Contoso application with Communication Services Clients permissions.
194-
1. Authentication is redirected to the *client application*, as defined in the property *Redirect URI* in the Contoso application.
195-
1. The Communication Common SDK seamlessly exchanges the Microsoft Entra user token for Azure Communication Services access token of Microsoft Entra ID user in the background.
193+
1. The Contoso *client application* uses the Azure Identity SDK to authenticate the user against the Fabrikam Microsoft Entra tenant for the Contoso application with Communication Services Clients permissions. Authentication is redirected to the *client application*, as defined in the property *Redirect URI* in the Contoso application.
194+
1. The Communication Common SDK seamlessly obtains an Azure Communication Services access token for Fabrikam Entra ID user in the background.
196195

197196
Developers can integrate the Communication Services Calling SDK or Chat SDK by providing `AzureCommunicationTokenCredential`.
198197

@@ -207,4 +206,4 @@ In this quickstart, you learned how to:
207206
Learn about the following concepts:
208207

209208
- [Support Microsoft Entra ID users in Azure Communication Services](../concepts/identity-model.md#microsoft-entra-id-integrating-with-entra-id)
210-
- [Single-tenant and multitenant authentication for Microsoft Entra Id users](../concepts/entra-id-authentication-overview.md)
209+
- [Single-tenant and multitenant authentication for Microsoft Entra ID users](../concepts/entra-id-authentication-overview.md)

articles/communication-services/quickstarts/identity/media/entra-id/entra-id-developer-overview.svg

Lines changed: 1 addition & 0 deletions
Loading

articles/communication-services/quickstarts/identity/media/entra-id/entra-id-user-overview.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)