Interface for credential stores which are used to store and lookup credentials to authenticate against external services.
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(context: IContext, key: string): Promise<CredentialParams>
- context: IContext - (optional) transaction id to trace execution through call chain.
- key: string - a key to uniquely identify the credential.
- returns: Promise<CredentialParams> - found credential parameters or null if nothing was found.
store
Stores credential parameters into the store.
store(context: IContext, key: string, credential: CredentialParams): Promise<void>
- context: IContext - (optional) transaction id to trace execution through call chain.
- key: string - a key to uniquely identify the credential.
- credential: CredentialParams - a credential to be stored.