ICredentialStore

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(context: Optional[IContext], key: str): CredentialParams

  • context: IContext - (optional) a context to trace execution through a 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(context: Optional[IContext], key: str, credential: CredentialParams)

  • context: IContext - (optional) a context to trace execution through a call chain.
  • key: str - a key to uniquely identify the credential.
  • credential: CredentialParams - a credential to be stored.

See also