Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync changes to production #228

Merged
merged 4 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificatePassword" />
<example>
<format type="text/markdown"><![CDATA[
The JSON fragment below describes a certificate retrieved by its path and a password to be used as a client credential in a confidential client application:
Expand All @@ -181,7 +181,7 @@
:::code language="csharp" source="~/../abstractions-samples/test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionTest.cs" id="path_csharp":::
]]></format>
</example>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificatePassword" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
</Docs>
</Member>
<Member MemberName="CertificateDistinguishedName">
Expand Down Expand Up @@ -210,8 +210,8 @@
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateThumbprint" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />
<example>
<format type="text/markdown"><![CDATA[
The JSON fragment below describes a user certificate stored in the personal certificates folder (<b>CurrentUser/My</b>) and specified by its distinguised name, used as a client credential in a confidential client application:
Expand All @@ -221,7 +221,7 @@
:::code language="csharp" source="~/../abstractions-samples/test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionTest.cs" id="distinguishedname_csharp":::
]]></format>
</example>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateThumbprint" />
</Docs>
</Member>
<Member MemberName="CertificatePassword">
Expand Down Expand Up @@ -250,7 +250,7 @@
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDiskPath" />
<example>
<format type="text/markdown"><![CDATA[
The JSON fragment below describes a certificate retrieved by its path and a password to be used as a client credential in a confidential client application:
Expand All @@ -260,7 +260,7 @@
:::code language="csharp" source="~/../abstractions-samples/test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionTest.cs" id="path_csharp":::
]]></format>
</example>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDiskPath" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
</Docs>
</Member>
<Member MemberName="CertificateStorePath">
Expand Down Expand Up @@ -291,10 +291,10 @@
</summary>
<value>To be added.</value>
<remarks>Use this property in conjunction with <see cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDistinguishedName" /> or <see cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateThumbprint" />.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDistinguishedName" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateThumbprint" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
</Docs>
</Member>
<Member MemberName="CertificateThumbprint">
Expand Down Expand Up @@ -323,8 +323,8 @@
</summary>
<value>To be added.</value>
<remarks>Use this property in conjunction with <see cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDistinguishedName" />
<example>
<format type="text/markdown"><![CDATA[
The JSON fragment below describes a user certificate stored in the personal certificates folder (<b>CurrentUser/My</b>) and specified by its thumbprint, used as a client credential in a confidential client application:
Expand All @@ -334,7 +334,7 @@
:::code language="csharp" source="~/../abstractions-samples/test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionTest.cs" id="thumbprint_csharp":::
]]></format>
</example>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateDistinguishedName" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.CertificateStorePath" />
</Docs>
</Member>
<Member MemberName="ClientSecret">
Expand Down Expand Up @@ -571,7 +571,7 @@
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.KeyVaultCertificateName" />
<example>
<format type="text/markdown"><![CDATA[
The JSON fragment below describes a certificate stored in Key Vault used as a client credential in a confidential client application:
Expand All @@ -581,7 +581,7 @@
:::code language="csharp" source="~/../abstractions-samples/test/Microsoft.Identity.Abstractions.Tests/CredentialDescriptionTest.cs" id="keyvault_csharp":::
]]></format>
</example>
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.KeyVaultCertificateName" />
<altmember cref="P:Microsoft.Identity.Abstractions.CredentialDescription.SourceType" />
</Docs>
</Member>
<Member MemberName="ManagedIdentityClientId">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
unless you are writing a custom credential loader.
</summary>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.Identity.Abstractions.ICredentialsLoader.LoadCredentialsIfNeededAsync(Microsoft.Identity.Abstractions.CredentialDescription,Microsoft.Identity.Abstractions.CredentialSourceLoaderParameters)" />
<altmember cref="M:Microsoft.Identity.Abstractions.ICredentialsLoader.LoadFirstValidCredentialsAsync(System.Collections.Generic.IEnumerable{Microsoft.Identity.Abstractions.CredentialDescription},Microsoft.Identity.Abstractions.CredentialSourceLoaderParameters)" />
<altmember cref="M:Microsoft.Identity.Abstractions.ICredentialsLoader.LoadCredentialsIfNeededAsync(Microsoft.Identity.Abstractions.CredentialDescription,Microsoft.Identity.Abstractions.CredentialSourceLoaderParameters)" />
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
Azure AD application)
</summary>
<remarks>To understand the difference between public client applications and confidential client applications, see https://aka.ms/msal-net-client-applications</remarks>
<altmember cref="T:Microsoft.Identity.Client.ConfidentialClientApplication" />
<altmember cref="T:Microsoft.Identity.Client.ClientCredential" />
<altmember cref="T:Microsoft.Identity.Client.ConfidentialClientApplication" />
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -561,8 +561,8 @@
</summary>
<returns>Authentication result containing a token for the requested scopes and account</returns>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)" />
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
</Docs>
</Member>
<Member MemberName="AcquireTokenOnBehalfOfAsync">
Expand Down Expand Up @@ -618,8 +618,8 @@
</summary>
<returns>Authentication result containing a token for the requested scopes and account</returns>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
<altmember cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)" />
</Docs>
</Member>
<Member MemberName="AppTokenCache">
Expand Down
1 change: 1 addition & 0 deletions msal-dotnet-articles/advanced/exceptions/broker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Troubleshooting brokered applications
description: Master brokered authentication on Android with our troubleshooting guide. Learn about redirect URIs, broker versions, precedence, and log acquisition.
---

# Troubleshooting brokered applications
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/advanced/exceptions/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Exceptions in MSAL.NET
description: "Documentation on exceptions and their handling in MSAL.NET"
description: Master handling exceptions in MSAL.NET with this comprehensive guide. Learn about different types of exceptions, common issues, and how to implement retry policies.
---

# Exceptions in MSAL.NET
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/advanced/exceptions/retry-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Retry policies
description: "This document explains how to implement a custom retry policy around token acquisition operations."
description: Learn how to implement a custom retry policy for token acquisition operations in .NET with MSAL. Increase your service availability with our detailed guide.
---

# Retry policies
Expand Down
1 change: 1 addition & 0 deletions msal-dotnet-articles/advanced/exceptions/unity.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Troubleshooting MSAL.NET in Unity applications
description: Learn how to troubleshoot MSAL.NET in Unity applications. Understand the cause of runtime exceptions and discover effective solutions.
---

# Troubleshooting MSAL.NET in Unity applications
Expand Down
1 change: 1 addition & 0 deletions msal-dotnet-articles/advanced/extensibility-points.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: MSAL.NET extensibility points
description: Explore advanced extensibility points in MSAL.NET for scalable apps. Adapt HttpClient factories, modify token requests, inject query parameters, and more.
---

# MSAL.NET extensibility points
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/advanced/high-availability.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: High availability considerations in MSAL.NET
description: "How to build highly available applications that use MSAL.NET."
description: Explore high availability considerations in MSAL.NET, including token cache, monitoring MSAL operations, logging, retry policy, and certificate rotation. Learn more now.
---

# High availability considerations in MSAL.NET
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/advanced/performance-testing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Performance testing of MSAL.NET
description: "Performance testing approach in MSAL.NET"
description: Explore performance testing of MSAL.NET with BenchmarkDotNet. Learn to run tests, view results, automate tests, and improve MSAL.NET performance.
---

# Performance testing of MSAL.NET
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/resources/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Known issues with MSAL.NET
description: "Known issues when integrating with MSAL.NET."
description: Troubleshoot MSAL.NET with our guide on known issues, including device compliance failures, AndroidActivityNotFound exceptions, and build issues.
---

# Known issues with MSAL.NET
Expand Down
1 change: 1 addition & 0 deletions msal-dotnet-articles/resources/telemetry-overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: MSAL.NET telemetry overview
description: Explore MSAL.NET's telemetry capabilities for Azure AD token endpoint requests. Learn about client-side state, error tracking, and SDK API usage metadata.
---

# MSAL.NET telemetry overview
Expand Down
2 changes: 1 addition & 1 deletion msal-dotnet-articles/resources/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Troubleshooting MSAL.NET
description: "How to troubleshoot some of the more common MSAL.NET issues."
description: Troubleshoot MSAL.NET issues with our comprehensive guide. Learn to fix JavaScript errors, region auto-discovery failures, and more on Microsoft's official site.
---

# Troubleshooting MSAL.NET
Expand Down