Skip to main content

IClientInfoManager Interface

Abblix.Oidc.Server​

Abblix.Oidc.Server.Features.ClientInformation​

IClientInfoManager Interface​

Defines operations for managing the lifecycle and information of OAuth 2.0 clients in a storage system.

public interface IClientInfoManager

Remarks​

Implementations of this interface are responsible for adding, updating, and removing client information, supporting dynamic client registration and management in OAuth 2.0 and OpenID Connect environments.

Methods​

IClientInfoManager.AddClientAsync(ClientInfo) Method​

Asynchronously adds a new client and its corresponding information to the storage system.

System.Threading.Tasks.Task AddClientAsync(Abblix.Oidc.Server.Features.ClientInformation.ClientInfo clientInfo);

Parameters​

clientInfo ClientInfo​

The detailed information about the client to be added.

Returns​

System.Threading.Tasks.Task
A task representing the asynchronous operation, indicating the completion of the addition process.

Remarks​

This operation typically involves persisting the clientInfo to a database or another form of storage, making the client available for OAuth 2.0 and OpenID Connect authentication and authorization processes.

IClientInfoManager.RemoveClientAsync(string) Method​

Asynchronously removes an existing client and its information from the storage system.

System.Threading.Tasks.Task RemoveClientAsync(string clientId);

Parameters​

clientId System.String​

The unique identifier of the client to be removed.

Returns​

System.Threading.Tasks.Task
A task representing the asynchronous operation, indicating the completion of the removal process.

Remarks​

The removal process is critical for maintaining the integrity and security of the client registration system, allowing administrators to effectively manage the lifecycle of client applications.

IClientInfoManager.UpdateClientAsync(ClientInfo) Method​

Asynchronously updates an existing client's information in the storage system.

System.Threading.Tasks.Task UpdateClientAsync(Abblix.Oidc.Server.Features.ClientInformation.ClientInfo clientInfo);

Parameters​

clientInfo ClientInfo​

The updated client information.

Returns​

System.Threading.Tasks.Task
A task representing the asynchronous operation, indicating the completion of the update process.

Remarks​

This operation updates the client metadata per RFC 7592 Section 2 (Client Update Request). The client must already exist in the storage system.