botframework-connector/src/auth/authenticationConfiguration.ts

Bot Connector is autorest generated connector client.

/**
 * @module botframework-connector
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Claim } from './claimsIdentity';

/**
 * Used to validate a list of Claims and should throw an exception if the validation fails.
 */
export type ValidateClaims = (claims: Claim[]) => Promise<void>;

/**
 * General configuration settings for authentication.
 */
export class AuthenticationConfiguration {
    /**
     * General configuration settings for authentication.
     *
     * @param {string[]} requiredEndorsements An array of JWT endorsements.
     * @param {(claims: Claim[]) => Promise<void>} validateClaims Function that validates a list of Claims
     * and should throw an exception if the validation fails.
     * @param {string[]} validTokenIssuers An array of valid JWT token issuers.
     */
    constructor(
        public requiredEndorsements: string[] = [],
        public validateClaims?: ValidateClaims,
        public validTokenIssuers?: string[],
    ) {}
}