SamlSerializer.LoadAdvice Method

Reference

Definition

Namespace:: System.IdentityModel.Tokens

Assembly:: System.IdentityModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Reads the additional information provided by the SAML authority within a <saml:Advice> element of a SAML assertion using the specified XML reader.

public:
 virtual System::IdentityModel::Tokens::SamlAdvice ^ LoadAdvice(System::Xml::XmlDictionaryReader ^ reader, System::IdentityModel::Selectors::SecurityTokenSerializer ^ keyInfoSerializer, System::IdentityModel::Selectors::SecurityTokenResolver ^ outOfBandTokenResolver);

public virtual System.IdentityModel.Tokens.SamlAdvice LoadAdvice (System.Xml.XmlDictionaryReader reader, System.IdentityModel.Selectors.SecurityTokenSerializer keyInfoSerializer, System.IdentityModel.Selectors.SecurityTokenResolver outOfBandTokenResolver);

abstract member LoadAdvice : System.Xml.XmlDictionaryReader * System.IdentityModel.Selectors.SecurityTokenSerializer * System.IdentityModel.Selectors.SecurityTokenResolver -> System.IdentityModel.Tokens.SamlAdvice
override this.LoadAdvice : System.Xml.XmlDictionaryReader * System.IdentityModel.Selectors.SecurityTokenSerializer * System.IdentityModel.Selectors.SecurityTokenResolver -> System.IdentityModel.Tokens.SamlAdvice

Public Overridable Function LoadAdvice (reader As XmlDictionaryReader, keyInfoSerializer As SecurityTokenSerializer, outOfBandTokenResolver As SecurityTokenResolver) As SamlAdvice

Parameters

reader: XmlDictionaryReader

An XmlDictionaryReader to read the additional information provided by the SAML authority.

keyInfoSerializer: SecurityTokenSerializer

A SecurityTokenSerializer that reads the KeyInfo clause of the digital signature.

outOfBandTokenResolver: SecurityTokenResolver

A SecurityTokenResolver that determines the security token that created the digital signature.

Returns

SamlAdvice

A SamlAdvice that contains additional information provided by the SAML authority within a <saml:Advice> element of a SAML assertion.

Exceptions

ArgumentNullException

reader is null

Remarks

The <saml:Advice> element within a SAML assertion is an extension point for SAML tokens. To create a serializer that can read the custom attributes, derive a class from SamlSerializer and override the LoadAdvice(XmlDictionaryReader, SecurityTokenSerializer, SecurityTokenResolver) method.

Applies to