API Reference
Interface
IAuthBundleStore
Abstraction for storing authentication bundles.
Usage
Explore 4 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Property CopilotNativeOptions.AuthStore
- Property OpenAINativeOptions.AuthStore
Accepted by parameters 2
- Method AuthBundleStoreExtensions.RemoveAsync
- Extension method IAuthBundleStore.RemoveAsync
Methods
public abstract Task<AuthBundle?> GetAsync(String provider, String? accountId = null, CancellationToken cancellationToken = default) #Returns:
Task<AuthBundle?>Retrieves a bundle for the specified provider and account.
Parameters
- provider System.String
- Provider identifier.
- accountId System.String? = null
- Optional account id.
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public abstract Task<IReadOnlyList<AuthBundle>> ListAsync(String provider, CancellationToken cancellationToken = default) #Returns:
Task<IReadOnlyList<AuthBundle>>Lists known bundles for the specified provider.
Parameters
- provider System.String
- Provider identifier.
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
public abstract Task SaveAsync(AuthBundle bundle, CancellationToken cancellationToken = default) #Returns:
TaskSaves an authentication bundle.
Parameters
- bundle IntelligenceX.OpenAI.Auth.AuthBundle
- Bundle to save.
- cancellationToken System.Threading.CancellationToken = default
- Cancellation token.
Extension Methods
public static Task RemoveAsync(IAuthBundleStore store, String provider, String? accountId, CancellationToken cancellationToken = default) #Returns:
TaskRemoves a stored account, or reports that the configured store does not support persistent sign-out.
Parameters
- store IntelligenceX.OpenAI.Auth.IAuthBundleStore
- provider System.String
- accountId System.String?
- cancellationToken System.Threading.CancellationToken = default
Exceptions
NotSupportedException– The store does not implement IRemovableAuthBundleStore.