SamlSecurityTokenRequirement.ValidateAudienceRestriction Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Checks the given list of Audience URIs with the AllowedAudienceUri list.

Namespace: Microsoft.IdentityModel.Tokens
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As SamlSecurityTokenRequirement
Dim allowedAudienceUris As IList(Of Uri)
Dim tokenAudiences As IList(Of Uri)

instance.ValidateAudienceRestriction(allowedAudienceUris, tokenAudiences)

Syntax

'Declaration
Public Overridable Sub ValidateAudienceRestriction ( _
    allowedAudienceUris As IList(Of Uri), _
    tokenAudiences As IList(Of Uri) _
)

public virtual void ValidateAudienceRestriction (
    IList<Uri> allowedAudienceUris,
    IList<Uri> tokenAudiences
)

public:
virtual void ValidateAudienceRestriction (
    IList<Uri^>^ allowedAudienceUris, 
    IList<Uri^>^ tokenAudiences
)

public void ValidateAudienceRestriction (
    IList<Uri> allowedAudienceUris, 
    IList<Uri> tokenAudiences
)

public function ValidateAudienceRestriction (
    allowedAudienceUris : IList<Uri>, 
    tokenAudiences : IList<Uri>
)

Parameters

allowedAudienceUris
Collection of AudienceUris.

tokenAudiences
Collection of audience URIs the token applies to.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'allowedAudienceUris' is null. -or- The input argument 'tokenAudiences' is null.
AudienceUriValidationFailedException	Either the input argument 'tokenAudiences' or the configured 'AudienceUris' collection is empty.

ArgumentNullException

The input argument 'allowedAudienceUris' is null.

-or-

The input argument 'tokenAudiences' is null.

AudienceUriValidationFailedException

Either the input argument 'tokenAudiences' or the configured 'AudienceUris' collection is empty.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via