ITokenCacheSerializer.DeserializeMsalV3(Byte[], Boolean) Method

Definition

Namespace:

Microsoft.Identity.Client

Assembly:

Microsoft.Identity.Client.dll

Package:

Microsoft.Identity.Client v4.60.3

Deserializes the token cache to the MSAL.NET 3.x cache format, which is compatible with other MSAL desktop libraries, including MSAL.NET 4.x, MSAL for Python and MSAL for Java. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with SerializeAdalV3()/DeserializeAdalV3(Byte[]), otherwise just use SerializeMsalV3()/DeserializeMsalV3(Byte[], Boolean).

public void DeserializeMsalV3 (byte[] msalV3State, bool shouldClearExistingCache = false);

abstract member DeserializeMsalV3 : byte[] * bool -> unit

Public Sub DeserializeMsalV3 (msalV3State As Byte(), Optional shouldClearExistingCache As Boolean = false)

Parameters

msalV3State

Byte[]

Byte stream representation of the cache

shouldClearExistingCache

Boolean

Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state.

Remarks

This is the recommended format for maintaining SSO state between applications. SerializeMsalV3()/DeserializeMsalV3(Byte[], Boolean) is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java.