pip_services3_components.auth.ICredentialStore module

pip_services3_components.auth.ICredentialStore

Credential store interface

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_components.auth.ICredentialStore.ICredentialStore

Bases: abc.ABC

Interface for credential stores which are used to store and lookup credentials to authenticate against external services.

lookup(correlation_id: Optional[str], key: str) → pip_services3_components.auth.CredentialParams.CredentialParams

Lookups credential parameters by its key.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • key – a key to uniquely identify the credential.

Returns

found credential parameters or None if nothing was found

store(correlation_id: Optional[str], key: str, credential: pip_services3_components.auth.CredentialParams.CredentialParams)

Stores credential parameters into the store.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • key – a key to uniquely identify the credential.

  • credential – a credential to be stored.