Skip to content

Commit

Permalink
Minor fix to update comment for TokenCacheRefreshArgs.SuggestedCacheK…
Browse files Browse the repository at this point in the history
…ey (#28128)

* Update comment for TokenCacheRefreshArgs.SuggestedCacheKey
  • Loading branch information
pmaytak authored Apr 12, 2022
1 parent 2decee4 commit 8724e58
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions sdk/identity/Azure.Identity/src/TokenCacheRefreshArgs.cs
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using Microsoft.Identity.Client;

namespace Azure.Identity
{
/// <summary>
/// Args setnt to TokenCache OnBefore and OnAfter events.
/// Args sent to TokenCache OnBefore and OnAfter events.
/// </summary>
public class TokenCacheRefreshArgs
{
/// <summary>
/// A suggested token cache key, which can be used with general purpose storage mechanisms that allow
/// storing key-value pairs and key based retrieval. Useful in applications that store 1 token cache per user,
/// storing key-value pairs and key based retrieval. Useful in applications that store one token cache per user,
/// the recommended pattern for web apps.
///
/// The value is:
///
/// <list type="bullet">
/// <item>the homeAccountId for AcquireTokenSilent, GetAccount(homeAccountId), RemoveAccount and when writing tokens on confidential client calls</item>
/// <item>clientID + "_AppTokenCache" for AcquireTokenForClient</item>
/// <item>clientID_tenantID + "_AppTokenCache" for AcquireTokenForClient when tenant specific authority</item>
/// <item>the hash of the original token for AcquireTokenOnBehalfOf</item>
/// <item><description><c>homeAccountId</c> for <c>AcquireTokenSilent</c>, <c>GetAccount(homeAccountId)</c>, <c>RemoveAccount</c> and when writing tokens on confidential client calls</description></item>
/// <item><description><c>"{clientId}__AppTokenCache"</c> for <c>AcquireTokenForClient</c></description></item>
/// <item><description><c>"{clientId}_{tenantId}_AppTokenCache"</c> for <c>AcquireTokenForClient</c> when using a tenant specific authority</description></item>
/// <item><description>the hash of the original token for <c>AcquireTokenOnBehalfOf</c></description></item>
/// </list>
/// </summary>
public string SuggestedCacheKey { get; }
Expand Down

0 comments on commit 8724e58

Please sign in to comment.