Interface for credential stores which are used to store and lookup credentials to authenticate against external services.
Implements: Factory
Description
The ICredentialStore interface is used to store and look up credentials used to authenticate against external services.
Instance methods
lookup
Lookups credential parameters by its key.
Future<CredentialParams?> lookup(String? correlationId, String? key)
- correlationId: String? - (optional) transaction id to trace execution through the call chain.
- key: String - key to uniquely identify the credential.
- returns: Future<CredentialParams?> - found credential parameters or null if nothing was found.
store
Stores credential parameters into the store.
Future store(String? correlationId, String key, CredentialParams credential)
- correlationId: String? - (optional) transaction id used to trace execution through the call chain.
- key: String - key to uniquely identify the credential.
- credential: CredentialParams - credential to be stored.