Interface IMemberIndexAuthorizer

Authorizes access to Examine indexes that hold member data.

Namespace: Umbraco.Cms.Api.Management.Services

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public interface IMemberIndexAuthorizer

Remarks

Member indexes hold login names, email addresses and member property values, so access to them requires access to the members section - not only to the settings section that the Examine management endpoints require.

Methods

View Source

HasAccessAsync(ClaimsPrincipal)

Gets a value indicating whether the supplied principal may access member data.

Declaration

Task<bool> HasAccessAsync(ClaimsPrincipal principal)

Parameters

Type	Name	Description
ClaimsPrincipal	principal	The principal to authorize.

Returns

Type	Description
Task<bool>	`true` if the principal may access member data; otherwise, `false`.

View Source

IsMemberIndex(IIndex)

Gets a value indicating whether the supplied index holds member data.

Declaration

bool IsMemberIndex(IIndex index)

Parameters

Type	Name	Description
IIndex	index	The index to check.

Returns

Type	Description
bool	`true` if the index holds member data; otherwise, `false`.

View Source

IsMemberIndex(string)

Gets a value indicating whether the supplied name identifies an index holding member data.

Declaration

bool IsMemberIndex(string indexOrSearcherName)

Parameters

Type	Name	Description
string	indexOrSearcherName	The name of the index, or of the index's searcher, to check.

Returns

Type	Description
bool	`true` if a matching index exists and holds member data; otherwise, `false`.

Remarks

Both names are matched because a searcher can be resolved either by its index name or by its own name - see TryFindSearcher(string, out ISearcher). A searcher registered on its own, without a backing index, cannot be classified and is therefore treated as not holding member data.