Microsoft.Identity.Web.TokenCache

Set of properties that the token cache serialization implementations might use to optimize the cache.

CancellationToken enabling cooperative cancellation between threads, thread pool, or Task objects.

Suggested cache expiry based on the in-coming token. Use to optimize cache eviction with the app token cache.

Extension class used to add distributed token cache serializer to MSAL. See https://aka.ms/ms-id-web/token-cache-serialization for details.

Adds the .NET Core distributed cache based app token cache to the service collection.

The services collection to add to. A to chain.

An implementation of the token cache for both Confidential and Public clients backed by a Distributed Cache. The Distributed Cache (L2), by default creates a Memory Cache (L1), for faster look up, resulting in a two level cache.

https://aka.ms/msal-net-token-cache-serialization

LoggingMessage class for MsalDistributedTokenCacheAdapter.

.NET Core Memory cache.

MSAL distributed token cache options.

Initializes a new instance of the class.

Distributed cache instance to use. Options for the token cache. MsalDistributedTokenCacheAdapter logger. Service provider. Can be null, in which case the token cache will not be encrypted. See https://aka.ms/ms-id-web/token-cache-encryption.

Removes a specific token cache, described by its cache key from the distributed cache.

Key of the cache to remove. A that completes when key removal has completed.

Removes a specific token cache, described by its cache key from the distributed cache.

Key of the cache to remove. Hints for the cache serialization implementation optimization. A that completes when key removal has completed.

Read a specific token cache, described by its cache key, from the distributed cache.

Key of the cache item to retrieve. Read blob representing a token cache for the cache key (account or app).

Read a specific token cache, described by its cache key, from the distributed cache.

Key of the cache item to retrieve. Hints for the cache serialization implementation optimization. Read blob representing a token cache for the cache key (account or app).

Writes a token cache blob to the serialization cache (by key).

Cache key. blob to write. A that completes when a write operation has completed.

Writes a token cache blob to the serialization cache (by key).

Cache key. blob to write. Hints for the cache serialization implementation optimization. A that completes when a write operation has completed.

LoggingMessage class for MsalDistributedTokenCacheAdapter.

Memory cache read.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). MSAL.NET cache key. Cache size in bytes, or 0 if empty. Exception.

Memory cache remove.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). MSAL.NET cache key. Exception.

Memory cache count.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). L1 cache count. Exception.

L2 cache state logging.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). MSAL.NET cache key. Cache size in bytes, or 0 if empty. L2 cache retry due to possible connection issue. Exception.

L2 cache state logging.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). MSAL.NET cache key. Cache size in bytes, or 0 if empty. L2 cache retry due to possible connection issue. Time in milliseconds. Exception.

L2 cache retry.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). MSAL.NET cache key. Exception.

L2 cache retry.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). Time in milliseconds. Exception.

L2 cache error.

ILogger. Distributed or Memory. Cache operation (Read, Write, etc...). L2 cache retry due to possible connection issue. Error message. Exception.

Back propagate L2 to L1.

ILogger. Cache size in bytes, or 0 if empty. Exception.

Options for the MSAL token cache serialization adapter, which delegates the serialization to the IDistributedCache implementations available with .NET Core.

Options of the In Memory (L1) cache.

Callback offered to the app to be notified when the L2 cache fails. This way the app is given the possibility to act on the L2 cache, for instance, in the case of Redis, to reconnect. This is left to the application as it's the only one that knows about the real implementation of the L2 cache. The handler should return true if the cache should try again the operation, and false otherwise. When true is passed and the retry fails, an exception will be thrown.

Value more than 0, less than 1, to set the In Memory (L1) cache expiration time values relative to the Distributed (L2) cache. Default is 1.

Should the token cache be encrypted.

The default is false.

Disable the L1 (InMemory) cache. Useful in scenarios where multiple apps share the same L2 cache.

The default is false.

Enable writing to the L2 cache to be async (fire and forget). This improves performance as the MSAL.NET will not have to wait for the write to complete.

The default is false.

MSAL token cache provider interface.

Initializes a token cache (which can be a user token cache or an app token cache).

Token cache for which to initialize the serialization. A that represents a completed initialization operation.

Initializes a token cache (which can be a user token cache or an app token cache).

Token cache for which to initialize the serialization.

Clear the user token cache.

HomeAccountId for a user account in the cache. A that represents a completed clear operation.

Extension class used to add an in-memory token cache serializer to MSAL.

Adds both the app and per-user in-memory token caches.

The services collection to add to. the services (for chaining).

MSAL's in-memory token cache options.

Initializes a new instance of the class. By default, the sliding expiration is set for 14 days.

Gets or sets the value of the duration after which the cache entry will expire unless it's used This is the duration the tokens are kept in memory cache. In production, a higher value, up-to 90 days is recommended.

The AbsoluteExpirationRelativeToNow value.

An implementation of token cache for both Confidential and Public clients backed by MemoryCache.

https://aka.ms/msal-net-token-cache-serialization

.NET Core Memory cache.

MSAL memory token cache options.

Constructor.

serialization cache. Memory cache options.

Removes a token cache identified by its key, from the serialization cache.

token cache key. A that completes when key removal has completed.

Reads a blob from the serialization cache (identified by its key).

Token cache key. Read Bytes.

Writes a token cache blob to the serialization cache (identified by its key).

Token cache key. Bytes to write. A that completes when a write operation has completed.

Writes a token cache blob to the serialization cache (identified by its key).

Token cache key. Bytes to write. Hints for the cache serialization implementation optimization. A that completes when a write operation has completed.

Token cache provider with default implementation.

LoggingMessage class for MsalAbstractTokenCacheProvider.

Constructor.

Service provider. Can be null, in which case the token cache will not be encrypted. See https://aka.ms/ms-id-web/token-cache-encryption.

Constructor.

Service provider. Can be null, in which case the token cache will not be encrypted. See https://aka.ms/ms-id-web/token-cache-encryption. MsalDistributedTokenCacheAdapter logger.

Initializes the token cache serialization.

Token cache to serialize/deserialize.

Initializes the token cache serialization.

Token cache to serialize/deserialize. A that represents a completed initialization operation.

Raised AFTER MSAL added the new token in its in-memory copy of the cache. This notification is called every time MSAL accesses the cache, not just when a write takes place: If MSAL's current operation resulted in a cache change, the property TokenCacheNotificationArgs.HasStateChanged will be set to true. If that is the case, we call the TokenCache.SerializeMsalV3() to get a binary blob representing the latest cache content – and persist it.

Contains parameters used by the MSAL call accessing the cache.

If you want to ensure that no concurrent write takes place, use this notification to place a lock on the entry.

Token cache notification arguments. A that represents a completed operation.

Clear the cache.

HomeAccountId for a user account in the cache. A that represents a completed clear operation.

Method to be implemented by concrete cache serializers to write the cache bytes.

Cache key. Bytes to write. A that represents a completed write operation.

Method to be overridden by concrete cache serializers to write the cache bytes.

Cache key. Bytes to write. Hints for the cache serialization implementation optimization. A that represents a completed write operation.

Method to be implemented by concrete cache serializers to Read the cache bytes.

Cache key. Read bytes.

Method to be overridden by concrete cache serializers to Read the cache bytes.

Cache key. Hints for the cache serialization implementation optimization. Read bytes.

Method to be implemented by concrete cache serializers to remove an entry from the cache.

Cache key. A that represents a completed remove key operation.

Method to be overridden by concrete cache serializers to remove an entry from the cache.

Cache key. Hints for the cache serialization implementation optimization. A that represents a completed remove key operation.

LoggingMessage class for MsalAbstractTokenCacheProvider.

Cache deserialization error.

ILogger. MSAL.NET cache key. Whether cache is encrypted or not. Error message. Exception.

Utility methods used by L1/L2 cache.

Extensions for .

New Object id claim: "oid".

Old Object Id claim: http://schemas.microsoft.com/identity/claims/objectidentifier.

Old TenantId claim: "http://schemas.microsoft.com/identity/claims/tenantid".

New Tenant Id claim: "tid".

PreferredUserName: "preferred_username".

Name claim: "name".

UserFlow claim: "http://schemas.microsoft.com/claims/authnclassreference".

Tfp claim: "tfp".

UniqueObjectIdentifier: "uid". Home Object Id.

UniqueTenantIdentifier: "utid". Home Tenant Id.

Name Identifier ID claim: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier".

Gets the account identifier for an MSAL.NET account from a .

Claims principal. A string corresponding to an account identifier as defined in .

Gets the unique object ID associated with the .

The from which to retrieve the unique object ID. This method returns the object ID both in case the developer has enabled or not claims mapping. Unique object ID of the identity, or null if it cannot be found.

Gets the Tenant ID associated with the .

The from which to retrieve the tenant ID. Tenant ID of the identity, or null if it cannot be found. This method returns the tenant ID both in case the developer has enabled or not claims mapping.

Gets the login-hint associated with a .

Identity for which to complete the login-hint. The login hint for the identity, or null if it cannot be found.

Gets the domain-hint associated with an identity.

Identity for which to compute the domain-hint. The domain hint for the identity, or null if it cannot be found.

Get the display name for the signed-in user, from the .

Claims about the user/account. A string containing the display name for the user, as determined by Azure AD (v1.0) and Microsoft identity platform (v2.0) tokens, or null if the claims cannot be found. See https://docs.microsoft.com/azure/active-directory/develop/id-tokens#payload-claims.

Gets the user flow ID associated with the .

The from which to retrieve the user flow ID. User flow ID of the identity, or null if it cannot be found.

Gets the Home Object ID associated with the .

The from which to retrieve the sub claim. Home Object ID (sub) of the identity, or null if it cannot be found.

Gets the Home Tenant ID associated with the .

The from which to retrieve the sub claim. Home Tenant ID (sub) of the identity, or null if it cannot be found.

Gets the NameIdentifierId associated with the .

The from which to retrieve the NameIdentifierId claim. Name identifier ID of the identity, or null if it cannot be found.

Extension methods to expose a simplified developer experience for adding token caches to MSAL.NET confidential client applications in ASP.NET, or .NET Core, or .NET FW.

Use a token cache and choose the serialization part by adding it to the services collection and configuring its options.

The confidential client application. Confidential client application. Action that you'll use to add a cache serialization to the service collection passed as an argument. The application for chaining. The following code adds a distributed in-memory token cache. app.AddTokenCaches(services => { // In memory distributed token cache // In net472, requires to reference Microsoft.Extensions.Caching.Memory services.AddDistributedTokenCache(); services.AddDistributedMemoryCache(); }); The following code adds a token cache based on REDIS and initializes its configuration. app.AddTokenCaches(services => { services.AddDistributedTokenCache(); // Redis token cache // Requires to reference Microsoft.Extensions.Caching.StackExchangeRedis services.AddStackExchangeRedisCache(options => { options.Configuration = "localhost"; options.InstanceName = "Redis"; }); }); If using distributed token caches, use AddDistributedTokenCache. Don't use this method in ASP.NET Core. Just add use the ConfigureServices method instead.

Add an in-memory well partitioned token cache to MSAL.NET confidential client application. Don't use this method in ASP.NET Core: rather use: services.AddInMemoryTokenCache() in ConfigureServices.

Confidential client application. The application for chaining. The following code adds an in-memory token cache. app.AddInMemoryTokenCache(); Don't use this method in ASP.NET Core. Just add use the ConfigureServices method instead.

Add an in-memory well partitioned token cache to MSAL.NET confidential client application. Don't use this method in ASP.NET Core: rather use: services.AddInMemoryTokenCache() in ConfigureServices.

Confidential client application. Action taking a and by which you initialize your memory cache. The application for chaining. The following code adds an in-memory token cache. app.AddInMemoryTokenCache(services => { services.Configure<MemoryCacheOptions>(options => { options.SizeLimit = 5000000; // in bytes (5 Mb), for example }); }); Don't use this method in ASP.NET Core. Just add use the ConfigureServices method instead.

Add a distributed token cache.

Confidential client application. Action taking a and by which you initialize your distributed cache. The application for chaining. The following code adds a token cache based on REDIS and initializes its configuration. app.AddDistributedTokenCache(services => { // Redis token cache // Requires to reference Microsoft.Extensions.Caching.StackExchangeRedis services.AddStackExchangeRedisCache(options => { options.Configuration = "localhost"; options.InstanceName = "Redis"; }); }); Don't use this method in ASP.NET Core. Just add use the ConfigureServices method instead.

EventIds for Logging.