JwtSecurityTokenHandler.ValidateAudience Method (JwtSecurityToken)

Validates that Audience is an expected value.

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel.Tokens.Jwt (in System.IdentityModel.Tokens.Jwt.dll)

Syntax

'Declaration
Protected Overridable Sub ValidateAudience ( _
    jwt As JwtSecurityToken _
)
protected virtual void ValidateAudience(
    JwtSecurityToken jwt
)
protected:
virtual void ValidateAudience(
    JwtSecurityToken^ jwt
)
abstract ValidateAudience : 
        jwt:JwtSecurityToken -> unit  
override ValidateAudience : 
        jwt:JwtSecurityToken -> unit
protected function ValidateAudience(
    jwt : JwtSecurityToken
)

Parameters

Exceptions

Exception Condition
ArgumentNullException

'jwt' is null.

InvalidOperationException

Configuration is null.

-or-Configuration.AudienceRestriction is null.

AudienceUriValidationFailedException

if IsNullOrWhiteSpace( Audience ) is true.

-or-Audience fails to match one of AllowedAudienceUris.

Remarks

If AudienceMode == Never OR( AudienceUriMode == BearerKeyOnly AND SecurityKeys.Count == 0 )then validation is skipped.

If validation is performed, Audience is compared to each Uri in AudienceRestriction.AllowedAudienceUris by comparing to OriginalString. Returns when first compare succeeds. Compare is performed using StringComparison.Ordinal (case sensitive).

.NET Framework Security

See Also

Reference

JwtSecurityTokenHandler Class

ValidateAudience Overload

System.IdentityModel.Tokens Namespace