Class SecurityEntityProvider
NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Signature for component that provides security entities which can be used to apply access rights for items (for example IContent).
Namespace: EPiServer.Security
Assembly: EPiServer.Framework.dll
Version: 9.12.2Syntax
public abstract class SecurityEntityProvider : ProviderBaseConstructors
SecurityEntityProvider()
Declaration
protected SecurityEntityProvider()Methods
GetRolesForUser(String)
Retrieves all roles for user with given userName.
Declaration
public abstract IEnumerable<string> GetRolesForUser(string userName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | userName | The name of the user. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | A list of all roles for the user. |
Search(String, String)
Searches all security entities of given type with a matching name.
Declaration
public abstract IEnumerable<SecurityEntity> Search(string partOfValue, string claimType)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfValue | Part of value to match or null to get all of given type. |
| System.String | claimType | The claimType to search for. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SecurityEntity> | A list of all matching entities or an empty list if no matches. |
Search(String, String, Int32, Int32, out Int32)
Searches all security entities of given type with a matching name with paging support.
Declaration
public abstract IEnumerable<SecurityEntity> Search(string partOfValue, string claimType, int startIndex, int maxRows, out int totalCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | partOfValue | Part of value to match or null to get all of given type. |
| System.String | claimType | The claim type to search for. |
| System.Int32 | startIndex | The start index, used for paging |
| System.Int32 | maxRows | The maximum number of rows returned |
| System.Int32 | totalCount | The total amount of matched entites. Return -1 if provider does not support paging. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SecurityEntity> | A list of all matching entities or an empty list if no matches. |
