Saml2SecurityTokenHandler.ResolveIssuerSigningKey Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.Tokens.Saml2

Assembly:: Microsoft.IdentityModel.Tokens.Saml.dll

Package:: Microsoft.IdentityModel.Tokens.Saml v7.5.1

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.

Returns a SecurityKey to use for validating the signature of a token.

protected virtual Microsoft.IdentityModel.Tokens.SecurityKey ResolveIssuerSigningKey (string token, Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken samlToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);

abstract member ResolveIssuerSigningKey : string * Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> Microsoft.IdentityModel.Tokens.SecurityKey
override this.ResolveIssuerSigningKey : string * Microsoft.IdentityModel.Tokens.Saml2.Saml2SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> Microsoft.IdentityModel.Tokens.SecurityKey

Protected Overridable Function ResolveIssuerSigningKey (token As String, samlToken As Saml2SecurityToken, validationParameters As TokenValidationParameters) As SecurityKey

Parameters

token: String

The String representation of the token that is being validated.

samlToken: Saml2SecurityToken

The Saml2SecurityToken that is being validated.

validationParameters: TokenValidationParameters

TokenValidationParameters that will be used during validation.

Returns

SecurityKey

Returns a SecurityKey to use for signature validation.

Exceptions

ArgumentNullException

If samlToken.Assertion' is null.

Remarks

If key fails to resolve, then null is returned.

Applies to