Interface ISSOTokenFileCache

Namespace

Amazon.Runtime.Credentials.Internal

Assembly

AWSSDK.Core.dll

public interface ISSOTokenFileCache

Methods

Exists(CredentialProfileOptions)

Returns true if a cache entry exists for the SsoToken represented by options.

bool Exists(CredentialProfileOptions options)

Parameters

options CredentialProfileOptions

Returns

bool

SaveSsoToken(SsoToken, string)

void SaveSsoToken(SsoToken token, string ssoCacheDirectory)

Parameters

token SsoToken

ssoCacheDirectory string

SaveSsoTokenAsync(SsoToken, string, CancellationToken)

Saves token to the SSO File Cache.

Task SaveSsoTokenAsync(SsoToken token, string ssoCacheDirectory, CancellationToken cancellationToken = default)

Parameters

token SsoToken

SsoToken to persist to disk.

ssoCacheDirectory string

Optional: Leave null/empty to default to (user profile)/.aws/sso/cache/

cancellationToken CancellationToken

Cancels the operation

Returns

Task

TryGetSsoToken(SSOTokenManagerGetTokenOptions, string, out SsoToken)

bool TryGetSsoToken(SSOTokenManagerGetTokenOptions getSsoTokenOptions, string ssoCacheDirectory, out SsoToken ssoToken)

Parameters

getSsoTokenOptions SSOTokenManagerGetTokenOptions

ssoCacheDirectory string

ssoToken SsoToken

Returns

bool

TryGetSsoTokenAsync(SSOTokenManagerGetTokenOptions, string, CancellationToken)

Tries to load a SsoToken from the SSO File Cache.

Task<TryResponse<SsoToken>> TryGetSsoTokenAsync(SSOTokenManagerGetTokenOptions getSsoTokenOptions, string ssoCacheDirectory, CancellationToken cancellationToken = default)

Parameters

getSsoTokenOptions SSOTokenManagerGetTokenOptions

Options containing details needed to lookup the SsoToken in cache.

ssoCacheDirectory string

Optional: Leave null/empty to default to (user profile)/.aws/sso/cache/

cancellationToken CancellationToken

Cancels the operation

Returns

Task<TryResponse<SsoToken>>

A TryResponse<T> indicating if a SsoToken was retrieved from cache.