Martinbarnas/communication identity/2021 10 31 preview (Azure#24665)

update Communication Identity api to version 2021-10-31-preview to enable M365 Teams identities

Author: martinbarnas-ms

sdk/communication/Azure.Communication.Identity/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Release History
 
 ## 1.1.0-beta.1 (Unreleased)
-- Added `ExchangeTeamsToken` to provide the ability to exchange a teams token for a communication access token
+- Updated version of Identity API to enable to build custom Teams endpoint using M365 Teams identities
 
 ## 1.0.1 (2021-05-25)
 - Dependency versions updated.

sdk/communication/Azure.Communication.Identity/README.md

@@ -114,9 +114,9 @@ Response revokeResponse = client.RevokeTokens(user);
 Response deleteResponse = client.DeleteUser(user);
 ```
 
-### Exchange access token
+### Exchanging AAD access token of a Teams User for a Communication Identity access token
 
-```C# Snippet:ExchangeTeamsToken
+```C# Snippet:ExchangeTeamsTokenAsync
 Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(teamsToken);
 string token = tokenResponse.Value.Token;
 Console.WriteLine($"Token: {token}");

sdk/communication/Azure.Communication.Identity/api/Azure.Communication.Identity.netstandard2.0.cs

@@ -22,11 +22,12 @@ public CommunicationIdentityClient(System.Uri endpoint, Azure.Core.TokenCredenti
     }
     public partial class CommunicationIdentityClientOptions : Azure.Core.ClientOptions
     {
-        public CommunicationIdentityClientOptions(Azure.Communication.Identity.CommunicationIdentityClientOptions.ServiceVersion version = Azure.Communication.Identity.CommunicationIdentityClientOptions.ServiceVersion.V2021_03_31_preview1) { }
+        public CommunicationIdentityClientOptions(Azure.Communication.Identity.CommunicationIdentityClientOptions.ServiceVersion version = Azure.Communication.Identity.CommunicationIdentityClientOptions.ServiceVersion.V2021_10_31_preview) { }
         public enum ServiceVersion
         {
             V2021_03_07 = 1,
             V2021_03_31_preview1 = 2,
+            V2021_10_31_preview = 3,
         }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]

sdk/communication/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClient.md

@@ -63,6 +63,16 @@ Console.WriteLine($"Token: {token}");
 Console.WriteLine($"Expires On: {expiresOn}");
 ```
 
+## Exchange an AAD access token of a Teams User for a Communication Identity access token
+
+The `CommunicationIdentityClient` can be used to exchange an AAD access token of a Teams user for a new Communication Identity access token with a matching expiration time.
+
+```C# Snippet:ExchangeTeamsToken
+Response<AccessToken> tokenResponse = client.ExchangeTeamsToken(teamsToken);
+string token = tokenResponse.Value.Token;
+Console.WriteLine($"Token: {token}");
+```
+
 <!--
 To see the full example source files, see:
 * [Generate user token][GenerateUserTokenCode]

sdk/communication/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClientAsync.md

@@ -65,6 +65,16 @@ Console.WriteLine($"Token: {token}");
 Console.WriteLine($"Expires On: {expiresOn}");
 ```
 
+## Exchange an AAD access token of a Teams User for a Communication Identity access token
+
+The `CommunicationIdentityClient` can be used to exchange an AAD access token of a Teams user for a new Communication Identity access token with a matching expiration time.
+
+```C# Snippet:ExchangeTeamsTokenAsync
+Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(teamsToken);
+string token = tokenResponse.Value.Token;
+Console.WriteLine($"Token: {token}");
+```
+
 <!--
 To see the full example source files, see:
 * [Generate user token][GenerateUserTokenCode]

sdk/communication/Azure.Communication.Identity/src/CommunicationIdentityClient.cs

@@ -281,8 +281,8 @@ public virtual async Task<Response> RevokeTokensAsync(CommunicationUserIdentifie
             }
         }
 
-        /// <summary>Exchange a teams token for a new ACS access token.</summary>
-        /// <param name="teamsToken">Teams token to acquire a new ACS access token.</param>
+        /// <summary>Exchange an AAD access token of a Teams User for a Communication Identity access token.</summary>
+        /// <param name="teamsToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
         public virtual Response<AccessToken> ExchangeTeamsToken(string teamsToken, CancellationToken cancellationToken = default)
@@ -301,8 +301,8 @@ public virtual Response<AccessToken> ExchangeTeamsToken(string teamsToken, Cance
             }
         }
 
-        /// <summary>Asynchronously exchange a teams token for a new ACS access token.</summary>
-        /// <param name="teamsToken">Teams token to acquire a new ACS access token.</param>
+        /// <summary>Asynchronously exchange an AAD access token of a Teams User for a Communication Identity access token.</summary>
+        /// <param name="teamsToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         public virtual async Task<Response<AccessToken>> ExchangeTeamsTokenAsync(String teamsToken, CancellationToken cancellationToken = default)
         {

sdk/communication/Azure.Communication.Identity/src/CommunicationIdentityClientOptions.cs

@@ -14,7 +14,7 @@ public class CommunicationIdentityClientOptions : ClientOptions
         /// <summary>
         /// The latest version of the identity service.
         /// </summary>
-        internal const ServiceVersion LatestVersion = ServiceVersion.V2021_03_31_preview1;
+        internal const ServiceVersion LatestVersion = ServiceVersion.V2021_10_31_preview;
 
         internal string ApiVersion { get; }
 
@@ -27,6 +27,7 @@ public CommunicationIdentityClientOptions(ServiceVersion version = LatestVersion
             {
                 ServiceVersion.V2021_03_07 => "2021-03-07",
                 ServiceVersion.V2021_03_31_preview1 => "2021-03-31-preview1",
+                ServiceVersion.V2021_10_31_preview => "2021-10-31-preview",
                 _ => throw new ArgumentOutOfRangeException(nameof(version)),
             };
         }
@@ -46,6 +47,10 @@ public enum ServiceVersion
             /// </summary>
 #pragma warning disable AZC0016 // Invalid ServiceVersion member name.
             V2021_03_31_preview1 = 2,
+            /// <summary>
+            /// The V2021_10_31_preview of the identity service.
+            /// </summary>
+            V2021_10_31_preview = 3,
 #pragma warning restore AZC0016 // Invalid ServiceVersion member name.
 #pragma warning restore CA1707 // Identifiers should not contain underscores
         }

sdk/communication/Azure.Communication.Identity/src/Generated/CommunicationIdentityRestClient.cs

@@ -6,8 +6,8 @@ Run `dotnet msbuild /t:GenerateCode` to generate code.
 > see https://aka.ms/autorest
 
 ``` yaml
-tag: package-2021-03-31-preview1
+tag: package-preview-2021-10
 require:
-    -  https://raw.githubusercontent.com/Azure/azure-rest-api-specs/896d05e37dbb00712726620b8d679cc3c3be09fb/specification/communication/data-plane/Identity/readme.md
+    -  https://raw.githubusercontent.com/Azure/azure-rest-api-specs/6f40b65610a4fad7a03f3fe8c57e8c0a9c3b77d0/specification/communication/data-plane/Identity/readme.md
 payload-flattening-threshold: 3
 ```