[Communication] - Identity - Auth with Token Credential (Azure#17438)

* [CommunicationIdentityClient] adding in new method to create beaer token. Fixing spelling mistake.

* [CommunicationIdentityClient] adding new init passing in token credential

* [TokenCredential] finalize the parameters to take in a token credential and an endpoint string

* [ClientOptionsExtensions] removing the scope from the BearerTokenAuth policy

* [CommunicationIdentityClientLiveTests] Adding new live test init with token credential

* [PhoneNumberAdministrationClient] revert the init with token

* [CommunicationIdentityClient] passing in endpoint as an uri

* [CommunicationIdentityClient] assert on the endpoint

* [CommunicationIdentityClient] reorder of the parameters

* Adding working live tests

* [Scripts] New generated code

* [CommunicationIdentityClient] update the comment for tokenCredential to be accurate

* [CommunicationIdentityClient] update the comment for endpoont to be more accurate

* [CommunicationIdentityClientLiveTests] Nit on the the test name

* Update CHANGELOG.md

* [IdentityClientFromTokenWithMultipleScopes] rename the generated files

* [CommunicationRecordedTestSanitizer] adding sanitizer to COMMUNICATION_ENDPOINT_STRING

Co-authored-by: Minnie Liu <peiliu@microsoft.com>

Author: JoshuaLai

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

@@ -2,6 +2,8 @@
 
 ## 1.0.0-beta.4 (Unreleased)
 
+### Added
+- Added support to create CommunicationIdentityClient with TokenCredential
 ### Fixed
 - Issue with paging results not pulling next pages
 

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

@@ -4,6 +4,7 @@ public partial class CommunicationIdentityClient
     {
         protected CommunicationIdentityClient() { }
         public CommunicationIdentityClient(string connectionString, Azure.Communication.Administration.CommunicationIdentityClientOptions? options = null) { }
+        public CommunicationIdentityClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredential, Azure.Communication.Administration.CommunicationIdentityClientOptions? options = null) { }
         public virtual Azure.Response<Azure.Communication.CommunicationUser> CreateUser(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CommunicationUser>> CreateUserAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response DeleteUser(Azure.Communication.CommunicationUser communicationUser, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

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

@@ -29,16 +29,34 @@ public CommunicationIdentityClient(string connectionString, CommunicationIdentit
                   options ?? new CommunicationIdentityClientOptions(),
                   ConnectionString.Parse(AssertNotNull(connectionString, nameof(connectionString))))
         { }
-
+        /// <summary> Initializes a new instance of <see cref="CommunicationIdentityClient"/>.</summary>
+        /// <param name="tokenCredential">The TokenCredential used to authenticate requests, such as DefaultAzureCredential.</param>
+        /// <param name="endpoint">The URI of the Azure Communication Services resource.</param>
+        /// <param name="options">Client option exposing <see cref="ClientOptions.Diagnostics"/>, <see cref="ClientOptions.Retry"/>, <see cref="ClientOptions.Transport"/>, etc.</param>
+        public CommunicationIdentityClient(Uri endpoint, TokenCredential tokenCredential, CommunicationIdentityClientOptions? options = default)
+            : this(
+                AssertNotNull(endpoint, nameof(endpoint)),
+                options ?? new CommunicationIdentityClientOptions(),
+                AssertNotNull(tokenCredential, nameof(tokenCredential)))
+        { }
         private CommunicationIdentityClient(CommunicationIdentityClientOptions options, ConnectionString connectionString)
         {
             _clientDiagnostics = new ClientDiagnostics(options);
             RestClient = new CommunicationIdentityRestClient(
                 _clientDiagnostics,
-                options.BuildHttpPipline(connectionString),
+                options.BuildHttpPipeline(connectionString),
                 connectionString.GetRequired("endpoint"));
         }
 
+        private CommunicationIdentityClient(Uri endpoint, CommunicationIdentityClientOptions options, TokenCredential tokenCredential)
+        {
+            _clientDiagnostics = new ClientDiagnostics(options);
+            RestClient = new CommunicationIdentityRestClient(
+                _clientDiagnostics,
+                options.BuildHttpPipeline(tokenCredential),
+                endpoint.AbsoluteUri);
+        }
+
         /// <summary>Initializes a new instance of <see cref="CommunicationIdentityClient"/> for mocking.</summary>
         protected CommunicationIdentityClient()
         {

sdk/communication/Azure.Communication.Administration/src/PhoneNumberAdministrationClient.cs

@@ -38,7 +38,7 @@ public PhoneNumberAdministrationClient(string connectionString, PhoneNumberAdmin
         { }
 
         internal PhoneNumberAdministrationClient(PhoneNumberAdministrationClientOptions options, ConnectionString connectionString)
-            : this(new ClientDiagnostics(options), options.BuildHttpPipline(connectionString), connectionString.GetRequired("endpoint"))
+            : this(new ClientDiagnostics(options), options.BuildHttpPipeline(connectionString), connectionString.GetRequired("endpoint"))
         { }
 
         internal PhoneNumberAdministrationClient(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, string endpointUrl)

sdk/communication/Azure.Communication.Administration/tests/CommunicationIdentityClient/CommunicationIdentityClientLiveTests.cs

@@ -1,11 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
 using System.Linq;
 using System.Threading.Tasks;
 using Azure.Communication.Administration.Models;
 using Azure.Communication.Identity;
+using Azure.Core;
 using Azure.Core.TestFramework;
+using Azure.Identity;
 using NUnit.Framework;
 
 namespace Azure.Communication.Administration.Tests
@@ -49,5 +52,28 @@ void ValidateScopesIfNotSanitized()
                 }
             }
         }
+
+        [Test]
+        [TestCase("chat", TestName = "IdentityClientFromTokenWithSingleScope")]
+        [TestCase("chat", "pstn", TestName = "IdentityClientFromTokenWithMultipleScopes")]
+        public async Task GeneratesIdentityUsingTokenCredentialWithScopes(params string[] scopes)
+        {
+            TokenCredential tokenCredential;
+            if (Mode == RecordedTestMode.Playback)
+            {
+                tokenCredential = new MockCredential();
+            }
+            else
+            {
+                tokenCredential = new DefaultAzureCredential();
+            }
+            CommunicationIdentityClient client = CreateInstrumentedCommunicationIdentityClientWithToken(tokenCredential);
+            Response<CommunicationUser> userResponse = await client.CreateUserAsync();
+            Response<CommunicationUserToken> tokenResponse = await client.IssueTokenAsync(userResponse.Value, scopes: scopes.Select(x => new CommunicationTokenScope(x)));
+
+            Assert.IsNotNull(tokenResponse.Value);
+            Assert.IsFalse(string.IsNullOrWhiteSpace(tokenResponse.Value.Token));
+            Assert.IsFalse(string.IsNullOrWhiteSpace(tokenResponse.Value.User.Id));
+        }
     }
 }

sdk/communication/Azure.Communication.Administration/tests/Infrastructure/CommunicationIdentityClientLiveTestBase.cs

@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System;
 using Azure.Communication.Pipeline;
+using Azure.Core;
 using Azure.Core.TestFramework;
 
 namespace Azure.Communication.Administration.Tests
@@ -21,5 +23,12 @@ protected CommunicationIdentityClient CreateInstrumentedCommunicationIdentityCli
                 new CommunicationIdentityClient(
                     TestEnvironment.ConnectionString,
                     InstrumentClientOptions(new CommunicationIdentityClientOptions())));
+
+        protected CommunicationIdentityClient CreateInstrumentedCommunicationIdentityClientWithToken(TokenCredential token)
+            => InstrumentClient(
+                new CommunicationIdentityClient(
+                    new Uri(TestEnvironment.EndpointString),
+                    token,
+                    InstrumentClientOptions(new CommunicationIdentityClientOptions())));
     }
 }

sdk/communication/Azure.Communication.Administration/tests/Infrastructure/CommunicationIdentityClientTestEnvironment.cs

@@ -10,5 +10,9 @@ public class CommunicationIdentityClientTestEnvironment: TestEnvironment
         internal const string ConnectionStringEnvironmentVariableName = "COMMUNICATION_CONNECTION_STRING";
 
         public string ConnectionString => GetRecordedVariable(ConnectionStringEnvironmentVariableName);
+
+        internal const string EndpointStringEnvironmentVariableName = "COMMUNICATION_ENDPOINT_STRING";
+
+        public string EndpointString => GetRecordedVariable(EndpointStringEnvironmentVariableName);
     }
 }