Share via

SamlSecurityTokenHandler.ReadSamlToken Method

  • Reference

Definition

Namespace:
Microsoft.IdentityModel.Tokens.Saml
Assembly:
Microsoft.IdentityModel.Tokens.Saml.dll
Package:
Microsoft.IdentityModel.Tokens.Saml v7.5.2

Overloads

ReadSamlToken(String)

Converts a string into an instance of SamlSecurityToken.
ReadSamlToken(XmlReader)

Reads a SamlSecurityToken where the XmlReader is positioned the beginning of a Saml assertion.

ReadSamlToken(String)

Converts a string into an instance of SamlSecurityToken.

public virtual Microsoft.IdentityModel.Tokens.Saml.SamlSecurityToken ReadSamlToken (string token);
abstract member ReadSamlToken : string -> Microsoft.IdentityModel.Tokens.Saml.SamlSecurityToken
override this.ReadSamlToken : string -> Microsoft.IdentityModel.Tokens.Saml.SamlSecurityToken
Public Overridable Function ReadSamlToken (token As String) As SamlSecurityToken

Parameters

token
String

a Saml token as a string.

Returns

SamlSecurityToken

A SamlSecurityToken

Exceptions

ArgumentNullException

If token is null or empty.

ArgumentException

If 'token.Length' is greater than MaximumTokenSizeInBytes.

Applies to

ReadSamlToken(XmlReader)

Reads a SamlSecurityToken where the XmlReader is positioned the beginning of a Saml assertion.

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

Parameters

reader
XmlReader

a XmlReader positioned at a 'saml:assertion' element.

Returns

SamlSecurityToken

A SamlSecurityToken

Exceptions

ArgumentNullException

If reader is null.

SamlSecurityTokenReadException

If ReadAssertion(XmlReader) returns null.

Applies to