Share via


Validators.ValidateAudience Method

Definition

Overloads

ValidateAudience(IEnumerable<String>, SecurityToken, TokenValidationParameters)

Determines if the audiences found in a SecurityToken are valid.

public static void ValidateAudience(System.Collections.Generic.IEnumerable<string> audiences, Microsoft.IdentityModel.Tokens.SecurityToken securityToken, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);
static member ValidateAudience : seq<string> * Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> unit
Public Shared Sub ValidateAudience (audiences As IEnumerable(Of String), securityToken As SecurityToken, validationParameters As TokenValidationParameters)

Parameters

audiences
IEnumerable<String>

The audiences found in the SecurityToken.

securityToken
SecurityToken

The SecurityToken being validated.

validationParameters
TokenValidationParameters

TokenValidationParameters required for validation.

Exceptions

If 'audiences' is null and ValidateAudience is true.

If none of the 'audiences' matched either ValidAudience or one of ValidAudiences.

Remarks

An EXACT match is required.

Applies to

ValidateAudience(IList<String>, SecurityToken, ValidationParameters, CallContext)

Determines if the audiences found in a SecurityToken are valid.

public static Microsoft.IdentityModel.Tokens.Experimental.ValidationResult<string,Microsoft.IdentityModel.Tokens.Experimental.AudienceValidationError> ValidateAudience(System.Collections.Generic.IList<string> tokenAudiences, Microsoft.IdentityModel.Tokens.SecurityToken? securityToken, Microsoft.IdentityModel.Tokens.Experimental.ValidationParameters validationParameters, Microsoft.IdentityModel.Tokens.CallContext callContext);
static member ValidateAudience : System.Collections.Generic.IList<string> * Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.Experimental.ValidationParameters * Microsoft.IdentityModel.Tokens.CallContext -> Microsoft.IdentityModel.Tokens.Experimental.ValidationResult<string, Microsoft.IdentityModel.Tokens.Experimental.AudienceValidationError>
Public Shared Function ValidateAudience (tokenAudiences As IList(Of String), securityToken As SecurityToken, validationParameters As ValidationParameters, callContext As CallContext) As ValidationResult(Of String, AudienceValidationError)

Parameters

tokenAudiences
IList<String>

The audiences found in the SecurityToken.

securityToken
SecurityToken

The SecurityToken being validated.

validationParameters
ValidationParameters

The TokenValidationParameters to be used for validating the token.

callContext
CallContext

The CallContext that contains call information.

Returns

Remarks

An EXACT match is required.

Applies to