View Source

Interface IBackOfficeUserClientCredentialsManager

Provides methods for managing client credentials associated with back office users.

Namespace: Umbraco.Cms.Core.Security

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IBackOfficeUserClientCredentialsManager

Methods

DeleteAsync(Guid, string)

Deletes the client credentials associated with the specified back office user.

Declaration

Task<Attempt<BackOfficeUserClientCredentialsOperationStatus>> DeleteAsync(Guid userKey, string clientId)

Parameters

Type	Name	Description
Guid	userKey	The unique identifier of the back office user whose credentials are to be deleted.
string	clientId	The identifier of the client credentials to delete.

Returns

Type	Description
Task<Attempt<BackOfficeUserClientCredentialsOperationStatus>>	A System.Threading.Tasks.Task<TResult> that represents the asynchronous delete operation. The task result contains an Attempt<TResult> indicating the outcome of the operation.

FindUserAsync(string)

Asynchronously finds the back office user associated with the specified client ID.

Declaration

Task<BackOfficeIdentityUser?> FindUserAsync(string clientId)

Parameters

Type	Name	Description
string	clientId	The client ID to search for.

Returns

Type	Description
Task<BackOfficeIdentityUser>	A task representing the asynchronous operation, with the result containing the BackOfficeIdentityUser if found; otherwise, null.

GetClientIdsAsync(Guid)

Asynchronously retrieves the client IDs associated with the specified back office user.

Declaration

Task<IEnumerable<string>> GetClientIdsAsync(Guid userKey)

Parameters

Type	Name	Description
Guid	userKey	The unique identifier of the back office user.

Returns

Type	Description
Task<IEnumerable<string>>	A task representing the asynchronous operation, containing an enumerable of client ID strings.

SaveAsync(Guid, string, string)

Asynchronously saves client credentials for the specified back office user.

Declaration

Task<Attempt<BackOfficeUserClientCredentialsOperationStatus>> SaveAsync(Guid userKey, string clientId, string clientSecret)

Parameters

Type	Name	Description
Guid	userKey	The unique identifier of the back office user.
string	clientId	The client identifier to save.
string	clientSecret	The client secret to save.

Returns

Type	Description
Task<Attempt<BackOfficeUserClientCredentialsOperationStatus>>	A System.Threading.Tasks.Task representing the asynchronous operation, containing an Attempt<TResult> indicating the result of the operation.