View Source

Class MemberClientCredentialsManager

Provides functionality for managing client credentials for members within the Umbraco CMS security framework.

Inheritance

object

ClientCredentialsManagerBase

Namespace: Umbraco.Cms.Core.Security

Assembly: Umbraco.Infrastructure.dll

Syntax

public sealed class MemberClientCredentialsManager : ClientCredentialsManagerBase, IMemberClientCredentialsManager

Constructors

MemberClientCredentialsManager(IOptions<DeliveryApiSettings>, IMemberManager, ILogger<MemberClientCredentialsManager>)

Initializes a new instance of the MemberClientCredentialsManager class.

Declaration

public MemberClientCredentialsManager(IOptions<DeliveryApiSettings> deliveryApiSettings, IMemberManager memberManager, ILogger<MemberClientCredentialsManager> logger)

Parameters

Type	Name	Description
IOptions<DeliveryApiSettings>	deliveryApiSettings	The Microsoft.Extensions.Options.IOptions<TOptions> containing the delivery API settings.
IMemberManager	memberManager	The IMemberManager instance used to manage members.
ILogger<MemberClientCredentialsManager>	logger	The Microsoft.Extensions.Logging.ILogger<TCategoryName> instance for logging.

Properties

ClientIdPrefix

Declaration

protected override string ClientIdPrefix { get; }

Property Value

Type	Description
string

Methods

FindMemberAsync(string)

Asynchronously finds a member associated with the specified client identifier.

Declaration

public Task<MemberIdentityUser?> FindMemberAsync(string clientId)

Parameters

Type	Name	Description
string	clientId	The client identifier used to locate the associated member.

Returns

Type	Description
Task<MemberIdentityUser>	A task representing the asynchronous operation. The task result contains the MemberIdentityUser if a matching member is found; otherwise, null.

GetAllAsync()

Asynchronously retrieves all member client credentials.

Declaration

public Task<IEnumerable<MemberClientCredentials>> GetAllAsync()

Returns

Type	Description
Task<IEnumerable<MemberClientCredentials>>	A task that represents the asynchronous operation. The task result contains an enumerable collection of MemberClientCredentials. If the manager is disabled, an empty collection is returned.