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.
lookup(correlation_id: Optional[str], key: str): CredentialParams
- correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
- key: str - a key to uniquely identify the credential.
- returns: CredentialParams - found credential parameters or None if nothing was found.
store
Stores credential parameters into the store.
store(correlation_id: Optional[str], key: str, credential: CredentialParams)
- correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
- key: str - a key to uniquely identify the credential.
- credential: CredentialParams - a credential to be stored.