Share via


SPClaimProvider.SupportsEntityInformation property

When implemented in a derived class, determines whether the claims provider supports information about augmenting claims to entities.

Namespace:  Microsoft.SharePoint.Administration.Claims
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property SupportsEntityInformation As Boolean
    Get
'Usage
Dim instance As SPClaimProvider
Dim value As Boolean

value = instance.SupportsEntityInformation
public abstract bool SupportsEntityInformation { get; }

Property value

Type: System.Boolean
true if the claims provider supports information about mapping to entities; otherwise false.

Remarks

When you include additional claims in a user's security token, you are augmenting claims. If you want to support claims augmentation, you must implement this property to return true. In addition, you must also implement the FillClaimsForEntity() method in the SPClaimProvider class.

For more information about claims augmentation, see How to: Create a claims provider in SharePoint 2013 and Claims provider in SharePoint 2013.The following code example shows how to enable support for claims augmentation.

Examples

// Supports claims augmentation
public override bool SupportsEntityInformation
{
    get { return true; }
}

See also

Reference

SPClaimProvider class

SPClaimProvider members

Microsoft.SharePoint.Administration.Claims namespace