pip-services3-components-node/src/auth/ICredentialStore.ts

Component definitions for Pip.Services in Node.js

/** @module auth */
import { CredentialParams } from './CredentialParams';

/**
 * Interface for credential stores which are used to store and lookup credentials
 * to authenticate against external services.
 * 
 * @see [[CredentialParams]]
 * @see [[ConnectionParams]]
 */
export interface ICredentialStore {
    /**
     * Stores credential parameters into the store.
     *
     * @param correlationId     (optional) transaction id to trace execution through call chain.
     * @param key               a key to uniquely identify the credential.
     * @param credential        a credential to be stored.
     * @param callback 			callback function that receives an error or null for success.
     */
    store(correlationId: string, key: String, credential: CredentialParams, callback: (err: any) => void): void;

    /**
     * Lookups credential parameters by its key.
     * 
     * @param correlationId     (optional) transaction id to trace execution through call chain.
     * @param key               a key to uniquely identify the credential.
     * @param callback          callback function that receives found credential or error.
     */
    lookup(correlationId: string, key: string, callback: (err: any, result: CredentialParams) => void): void;
}