Saml2SecurityTokenHandler.ReadSaml2Token Method

  • Reference

Definition

Namespace:
Microsoft.IdentityModel.Tokens.Saml2
Assembly:
Microsoft.IdentityModel.Tokens.Saml.dll
Package:
Microsoft.IdentityModel.Tokens.Saml v7.5.1

Overloads

ReadSaml2Token(String)

Converts a string into an instance of Saml2SecurityToken.
ReadSaml2Token(XmlReader)

Reads a Saml2SecurityToken where the XmlReader is positioned the beginning of a Saml2 assertion.

ReadSaml2Token(String)

Converts a string into an instance of Saml2SecurityToken.

public virtual Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken ReadSaml2Token (string token);
abstract member ReadSaml2Token : string -> Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken
override this.ReadSaml2Token : string -> Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken
Public Overridable Function ReadSaml2Token (token As String) As Saml2SecurityToken

Parameters

token
String

a Saml2 token as a string.

Returns

Saml2SecurityToken

A Saml2SecurityToken

Exceptions

ArgumentNullException

If token is null or empty.

ArgumentException

If token.Length is greater than MaximumTokenSizeInBytes.

Applies to

ReadSaml2Token(XmlReader)

Reads a Saml2SecurityToken where the XmlReader is positioned the beginning of a Saml2 assertion.

public virtual Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken ReadSaml2Token (System.Xml.XmlReader reader);
abstract member ReadSaml2Token : System.Xml.XmlReader -> Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken
override this.ReadSaml2Token : System.Xml.XmlReader -> Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken
Public Overridable Function ReadSaml2Token (reader As XmlReader) As Saml2SecurityToken

Parameters

reader
XmlReader

A XmlReader reader positioned at a saml2 assertion element.

Returns

Saml2SecurityToken

A Saml2SecurityToken.

Exceptions

ArgumentNullException

If reader is null.

Saml2SecurityTokenReadException

If ReadAssertion(XmlReader) returns null.

Applies to