Identity release archboard feedback (Azure#38166)

christothes · web-flow · commit 4fc53c8c8cd7 · 2023-08-14T13:06:36.000-05:00
diff --git a/sdk/identity/Azure.Identity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.net462.cs b/sdk/identity/Azure.Identity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.net462.cs
@@ -3,10 +3,12 @@ namespace Azure.Identity.BrokeredAuthentication
     public partial class InteractiveBrowserCredentialBrokerOptions : Azure.Identity.InteractiveBrowserCredentialOptions
     {
         public InteractiveBrowserCredentialBrokerOptions(System.IntPtr parentWindowHandle) { }
+        public bool? IsMsaPassthroughEnabled { get { throw null; } set { } }
     }
     public partial class SharedTokenCacheCredentialBrokerOptions : Azure.Identity.SharedTokenCacheCredentialOptions
     {
         public SharedTokenCacheCredentialBrokerOptions() { }
         public SharedTokenCacheCredentialBrokerOptions(Azure.Identity.TokenCachePersistenceOptions tokenCacheOptions) { }
+        public bool? IsMsaPassthroughEnabled { get { throw null; } set { } }
     }
 }
diff --git a/sdk/identity/Azure.Identity/CHANGELOG.md b/sdk/identity/Azure.Identity/CHANGELOG.md
@@ -3,7 +3,7 @@
 ## 1.10.0-beta.2 (Unreleased)
 
 ### Features Added
-- Add `BrowserCustomizedOptions` to `InteractiveBrowserCredential` to enable web view customization for interactive authentication.
+- Added `BrowserCustomization` property to `InteractiveBrowserCredential` to enable web view customization for interactive authentication.
 
 ### Breaking Changes
 
diff --git a/sdk/identity/Azure.Identity/api/Azure.Identity.netstandard2.0.cs b/sdk/identity/Azure.Identity/api/Azure.Identity.netstandard2.0.cs
@@ -94,10 +94,10 @@ public AzurePowerShellCredentialOptions() { }
     }
     public partial class BrowserCustomizationOptions
     {
-        public bool? UseEmbeddedWebView;
         public BrowserCustomizationOptions() { }
-        public string HtmlMessageError { get { throw null; } set { } }
-        public string HtmlMessageSuccess { get { throw null; } set { } }
+        public string ErrorMessage { get { throw null; } set { } }
+        public string SuccessMessage { get { throw null; } set { } }
+        public bool? UseEmbeddedWebView { get { throw null; } set { } }
     }
     public partial class ChainedTokenCredential : Azure.Core.TokenCredential
     {
@@ -281,7 +281,7 @@ public partial class InteractiveBrowserCredentialOptions : Azure.Identity.TokenC
         public InteractiveBrowserCredentialOptions() { }
         public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }
         public Azure.Identity.AuthenticationRecord AuthenticationRecord { get { throw null; } set { } }
-        public Azure.Identity.BrowserCustomizationOptions BrowserCustomizedOptions { get { throw null; } set { } }
+        public Azure.Identity.BrowserCustomizationOptions BrowserCustomization { get { throw null; } set { } }
         public string ClientId { get { throw null; } set { } }
         public bool DisableAutomaticAuthentication { get { throw null; } set { } }
         public bool DisableInstanceDiscovery { get { throw null; } set { } }
diff --git a/sdk/identity/Azure.Identity/src/Credentials/BrowserCustomizationOptions.cs b/sdk/identity/Azure.Identity/src/Credentials/BrowserCustomizationOptions.cs
@@ -17,7 +17,7 @@ public class BrowserCustomizationOptions
         /// Specifies if the public client application should used an embedded web browser
         /// or the system default browser
         /// </summary>
-        public bool? UseEmbeddedWebView;
+        public bool? UseEmbeddedWebView { get; set; }
 
         internal SystemWebViewOptions SystemBrowserOptions;
 
@@ -34,7 +34,7 @@ private SystemWebViewOptions systemWebViewOptions
         /// Property to set HtmlMessageSuccess of SystemWebViewOptions from MSAL,
         /// which the browser will show to the user when the user finishes authenticating successfully.
         /// </summary>
-        public string HtmlMessageSuccess
+        public string SuccessMessage
         {
             get
             {
@@ -52,7 +52,7 @@ public string HtmlMessageSuccess
         /// which the browser will show to the user when the user finishes authenticating, but an error occurred.
         /// You can use a string format e.g. "An error has occurred: {0} details: {1}".
         /// </summary>
-        public string HtmlMessageError
+        public string ErrorMessage
         {
             get
             {
diff --git a/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredential.cs b/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredential.cs
@@ -21,7 +21,7 @@ public class InteractiveBrowserCredential : TokenCredential
         internal string[] AdditionallyAllowedTenantIds { get; }
         internal string ClientId { get; }
         internal string LoginHint { get; }
-        internal BrowserCustomizationOptions BrowserCustomizedOptions { get; }
+        internal BrowserCustomizationOptions BrowserCustomization { get; }
         internal MsalPublicClient Client { get; }
         internal CredentialPipeline Pipeline { get; }
         internal bool DisableAutomaticAuthentication { get; }
@@ -91,7 +91,7 @@ internal InteractiveBrowserCredential(string tenantId, string clientId, TokenCre
             Client = client ?? new MsalPublicClient(Pipeline, tenantId, clientId, redirectUrl, options);
             AdditionallyAllowedTenantIds = TenantIdResolver.ResolveAddionallyAllowedTenantIds((options as ISupportsAdditionallyAllowedTenants)?.AdditionallyAllowedTenants);
             Record = (options as InteractiveBrowserCredentialOptions)?.AuthenticationRecord;
-            BrowserCustomizedOptions = (options as InteractiveBrowserCredentialOptions)?.BrowserCustomizedOptions;
+            BrowserCustomization = (options as InteractiveBrowserCredentialOptions)?.BrowserCustomization;
         }
 
         /// <summary>
@@ -242,7 +242,7 @@ private async Task<AccessToken> GetTokenViaBrowserLoginAsync(TokenRequestContext
 
             var tenantId = TenantIdResolver.Resolve(TenantId ?? Record?.TenantId, context, AdditionallyAllowedTenantIds);
             AuthenticationResult result = await Client
-                .AcquireTokenInteractiveAsync(context.Scopes, context.Claims, prompt, LoginHint, tenantId, context.IsCaeEnabled, BrowserCustomizedOptions, async, cancellationToken)
+                .AcquireTokenInteractiveAsync(context.Scopes, context.Claims, prompt, LoginHint, tenantId, context.IsCaeEnabled, BrowserCustomization, async, cancellationToken)
                 .ConfigureAwait(false);
 
             Record = new AuthenticationRecord(result, ClientId);
diff --git a/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredentialOptions.cs b/sdk/identity/Azure.Identity/src/Credentials/InteractiveBrowserCredentialOptions.cs
@@ -69,6 +69,6 @@ public string TenantId
         /// <summary>
         /// The options for customizing the browser for interactive authentication.
         /// </summary>
-        public BrowserCustomizationOptions BrowserCustomizedOptions { get; set; }
+        public BrowserCustomizationOptions BrowserCustomization { get; set; }
     }
 }
diff --git a/sdk/identity/Azure.Identity/tests/InteractiveBrowserCredentialTests.cs b/sdk/identity/Azure.Identity/tests/InteractiveBrowserCredentialTests.cs
@@ -294,25 +294,25 @@ public async Task InvokesBeforeBuildClientOnExtendedOptions()
         }
 
         [Test]
-        public async Task BrowserCustomizedOptionsHtmlMessage([Values(null, "<p> Login Successfully.</p>")] string htmlMessageSuccess, [Values(null, "<p> An error occured: {0}. Details {1}</p>")] string htmlMessageError)
+        public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Successfully.</p>")] string htmlMessageSuccess, [Values(null, "<p> An error occured: {0}. Details {1}</p>")] string htmlMessageError)
         {
             var mockMsalClient = new MockMsalPublicClient
             {
                 InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>
                 {
                     Assert.AreEqual(false, browserOptions.UseEmbeddedWebView);
-                    Assert.AreEqual(htmlMessageSuccess, browserOptions.HtmlMessageSuccess);
-                    Assert.AreEqual(htmlMessageError, browserOptions.HtmlMessageError);
+                    Assert.AreEqual(htmlMessageSuccess, browserOptions.SuccessMessage);
+                    Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);
                     return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));
                 }
             };
             var options = new InteractiveBrowserCredentialOptions()
             {
-                BrowserCustomizedOptions = new BrowserCustomizationOptions()
+                BrowserCustomization = new BrowserCustomizationOptions()
                 {
                     UseEmbeddedWebView = false,
-                    HtmlMessageSuccess = htmlMessageSuccess,
-                    HtmlMessageError = htmlMessageError
+                    SuccessMessage = htmlMessageSuccess,
+                    ErrorMessage = htmlMessageError
                 }
             };
 
@@ -329,16 +329,16 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)
                 InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>
                 {
                     Assert.AreEqual(useEmbeddedWebView, browserOptions.UseEmbeddedWebView);
-                    Assert.AreEqual(htmlMessageError, browserOptions.HtmlMessageError);
+                    Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);
                     return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));
                 }
             };
             var options = new InteractiveBrowserCredentialOptions()
             {
-                BrowserCustomizedOptions = new BrowserCustomizationOptions()
+                BrowserCustomization = new BrowserCustomizationOptions()
                 {
                     UseEmbeddedWebView = useEmbeddedWebView,
-                    HtmlMessageError = htmlMessageError
+                    ErrorMessage = htmlMessageError
                 }
             };
 

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,12 @@ namespace Azure.Identity.BrokeredAuthentication`
`3`	`3`	`public partial class InteractiveBrowserCredentialBrokerOptions : Azure.Identity.InteractiveBrowserCredentialOptions`
`4`	`4`	`{`
`5`	`5`	`public InteractiveBrowserCredentialBrokerOptions(System.IntPtr parentWindowHandle) { }`
	`6`	`+ public bool? IsMsaPassthroughEnabled { get { throw null; } set { } }`
`6`	`7`	`}`
`7`	`8`	`public partial class SharedTokenCacheCredentialBrokerOptions : Azure.Identity.SharedTokenCacheCredentialOptions`
`8`	`9`	`{`
`9`	`10`	`public SharedTokenCacheCredentialBrokerOptions() { }`
`10`	`11`	`public SharedTokenCacheCredentialBrokerOptions(Azure.Identity.TokenCachePersistenceOptions tokenCacheOptions) { }`
	`12`	`+ public bool? IsMsaPassthroughEnabled { get { throw null; } set { } }`
`11`	`13`	`}`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,10 +94,10 @@ public AzurePowerShellCredentialOptions() { }`
`94`	`94`	`}`
`95`	`95`	`public partial class BrowserCustomizationOptions`
`96`	`96`	`{`
`97`		`- public bool? UseEmbeddedWebView;`
`98`	`97`	`public BrowserCustomizationOptions() { }`
`99`		`- public string HtmlMessageError { get { throw null; } set { } }`
`100`		`- public string HtmlMessageSuccess { get { throw null; } set { } }`
	`98`	`+ public string ErrorMessage { get { throw null; } set { } }`
	`99`	`+ public string SuccessMessage { get { throw null; } set { } }`
	`100`	`+ public bool? UseEmbeddedWebView { get { throw null; } set { } }`
`101`	`101`	`}`
`102`	`102`	`public partial class ChainedTokenCredential : Azure.Core.TokenCredential`
`103`	`103`	`{`
`@@ -281,7 +281,7 @@ public partial class InteractiveBrowserCredentialOptions : Azure.Identity.TokenC`
`281`	`281`	`public InteractiveBrowserCredentialOptions() { }`
`282`	`282`	`public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }`
`283`	`283`	`public Azure.Identity.AuthenticationRecord AuthenticationRecord { get { throw null; } set { } }`
`284`		`- public Azure.Identity.BrowserCustomizationOptions BrowserCustomizedOptions { get { throw null; } set { } }`
	`284`	`+ public Azure.Identity.BrowserCustomizationOptions BrowserCustomization { get { throw null; } set { } }`
`285`	`285`	`public string ClientId { get { throw null; } set { } }`
`286`	`286`	`public bool DisableAutomaticAuthentication { get { throw null; } set { } }`
`287`	`287`	`public bool DisableInstanceDiscovery { get { throw null; } set { } }`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public class BrowserCustomizationOptions`
`17`	`17`	`/// Specifies if the public client application should used an embedded web browser`
`18`	`18`	`/// or the system default browser`
`19`	`19`	`/// </summary>`
`20`		`- public bool? UseEmbeddedWebView;`
	`20`	`+ public bool? UseEmbeddedWebView { get; set; }`
`21`	`21`
`22`	`22`	`internal SystemWebViewOptions SystemBrowserOptions;`
`23`	`23`
`@@ -34,7 +34,7 @@ private SystemWebViewOptions systemWebViewOptions`
`34`	`34`	`/// Property to set HtmlMessageSuccess of SystemWebViewOptions from MSAL,`
`35`	`35`	`/// which the browser will show to the user when the user finishes authenticating successfully.`
`36`	`36`	`/// </summary>`
`37`		`- public string HtmlMessageSuccess`
	`37`	`+ public string SuccessMessage`
`38`	`38`	`{`
`39`	`39`	`get`
`40`	`40`	`{`
`@@ -52,7 +52,7 @@ public string HtmlMessageSuccess`
`52`	`52`	`/// which the browser will show to the user when the user finishes authenticating, but an error occurred.`
`53`	`53`	`/// You can use a string format e.g. "An error has occurred: {0} details: {1}".`
`54`	`54`	`/// </summary>`
`55`		`- public string HtmlMessageError`
	`55`	`+ public string ErrorMessage`
`56`	`56`	`{`
`57`	`57`	`get`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,6 @@ public string TenantId`
`69`	`69`	`/// <summary>`
`70`	`70`	`/// The options for customizing the browser for interactive authentication.`
`71`	`71`	`/// </summary>`
`72`		`- public BrowserCustomizationOptions BrowserCustomizedOptions { get; set; }`
	`72`	`+ public BrowserCustomizationOptions BrowserCustomization { get; set; }`
`73`	`73`	`}`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -294,25 +294,25 @@ public async Task InvokesBeforeBuildClientOnExtendedOptions()`
`294`	`294`	`}`
`295`	`295`
`296`	`296`	`[Test]`
`297`		`- public async Task BrowserCustomizedOptionsHtmlMessage([Values(null, "<p> Login Successfully.</p>")] string htmlMessageSuccess, [Values(null, "<p> An error occured: {0}. Details {1}</p>")] string htmlMessageError)`
	`297`	`+ public async Task BrowserCustomizationsHtmlMessage([Values(null, "<p> Login Successfully.</p>")] string htmlMessageSuccess, [Values(null, "<p> An error occured: {0}. Details {1}</p>")] string htmlMessageError)`
`298`	`298`	`{`
`299`	`299`	`var mockMsalClient = new MockMsalPublicClient`
`300`	`300`	`{`
`301`	`301`	`InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>`
`302`	`302`	`{`
`303`	`303`	`Assert.AreEqual(false, browserOptions.UseEmbeddedWebView);`
`304`		`- Assert.AreEqual(htmlMessageSuccess, browserOptions.HtmlMessageSuccess);`
`305`		`- Assert.AreEqual(htmlMessageError, browserOptions.HtmlMessageError);`
	`304`	`+ Assert.AreEqual(htmlMessageSuccess, browserOptions.SuccessMessage);`
	`305`	`+ Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);`
`306`	`306`	`return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));`
`307`	`307`	`}`
`308`	`308`	`};`
`309`	`309`	`var options = new InteractiveBrowserCredentialOptions()`
`310`	`310`	`{`
`311`		`- BrowserCustomizedOptions = new BrowserCustomizationOptions()`
	`311`	`+ BrowserCustomization = new BrowserCustomizationOptions()`
`312`	`312`	`{`
`313`	`313`	`UseEmbeddedWebView = false,`
`314`		`- HtmlMessageSuccess = htmlMessageSuccess,`
`315`		`- HtmlMessageError = htmlMessageError`
	`314`	`+ SuccessMessage = htmlMessageSuccess,`
	`315`	`+ ErrorMessage = htmlMessageError`
`316`	`316`	`}`
`317`	`317`	`};`
`318`	`318`
`@@ -329,16 +329,16 @@ public async Task BrowserCustomizedUseEmbeddedWebView([Values(null, true, false)`
`329`	`329`	`InteractiveAuthFactory = (_, _, _, _, _, _, browserOptions, _) =>`
`330`	`330`	`{`
`331`	`331`	`Assert.AreEqual(useEmbeddedWebView, browserOptions.UseEmbeddedWebView);`
`332`		`- Assert.AreEqual(htmlMessageError, browserOptions.HtmlMessageError);`
	`332`	`+ Assert.AreEqual(htmlMessageError, browserOptions.ErrorMessage);`
`333`	`333`	`return AuthenticationResultFactory.Create(Guid.NewGuid().ToString(), expiresOn: DateTimeOffset.UtcNow.AddMinutes(5));`
`334`	`334`	`}`
`335`	`335`	`};`
`336`	`336`	`var options = new InteractiveBrowserCredentialOptions()`
`337`	`337`	`{`
`338`		`- BrowserCustomizedOptions = new BrowserCustomizationOptions()`
	`338`	`+ BrowserCustomization = new BrowserCustomizationOptions()`
`339`	`339`	`{`
`340`	`340`	`UseEmbeddedWebView = useEmbeddedWebView,`
`341`		`- HtmlMessageError = htmlMessageError`
	`341`	`+ ErrorMessage = htmlMessageError`
`342`	`342`	`}`
`343`	`343`	`};`
`344`	`344`