Interface IProviderRefreshClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Gateway-owned credential refresh operations.

public interface IProviderRefreshClient

Methods

ConfigureAsync(RefreshConfig, CancellationToken)

Configures refresh for a credential.

ValueTask<RefreshStatus> ConfigureAsync(RefreshConfig config, CancellationToken cancellationToken = default)

Parameters

config RefreshConfig

cancellationToken CancellationToken

Returns

ValueTask<RefreshStatus>

DeleteAsync(string, string, DeleteOptions?, CancellationToken)

Deletes refresh configuration.

ValueTask<DeletionResult> DeleteAsync(string provider, string credentialKey, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

provider string

credentialKey string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

GetStatusAsync(string, string?, CancellationToken)

Gets refresh status for one credential key, or for every credential when credentialKey is null.

ValueTask<IReadOnlyList<RefreshStatus>> GetStatusAsync(string provider, string? credentialKey = null, CancellationToken cancellationToken = default)

Parameters

provider string

credentialKey string

cancellationToken CancellationToken

Returns

ValueTask<IReadOnlyList<RefreshStatus>>

RotateAsync(string, string, string?, CancellationToken)

Forces a credential rotation.

ValueTask<RefreshStatus> RotateAsync(string provider, string credentialKey, string? requestId = null, CancellationToken cancellationToken = default)

Parameters

provider string

credentialKey string

requestId string

cancellationToken CancellationToken

Returns

ValueTask<RefreshStatus>