@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/update/update-connection-certificate/UpdateConnectionCertificate.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var EndevorConnectionOptions = require('../../../options/EndevorConnectionOptions.js');

/*
 * Copyright (c) 2026 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 *
 */
const UpdateConnectionCertificateDefinition = {
    name: "endevor-connection-certificate",
    aliases: ["connection-certificate", "certificate", "cer"],
    type: "command",
    handler: __dirname + "/UpdateConnectionCertificate.handler",
    description: "Update your Endevor Connection certificate for the Endevor connection.",
    positionals: [EndevorConnectionOptions.EndevorConnectionOptions.CONNECTION],
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    options: [
        EndevorConnectionOptions.EndevorConnectionOptions.LOGIN_URL,
        EndevorConnectionOptions.EndevorConnectionOptions.TYPE,
        EndevorConnectionOptions.EndevorConnectionOptions.PUBLIC_CERT,
        EndevorConnectionOptions.EndevorConnectionOptions.PRIVATE_KEY,
        EndevorConnectionOptions.EndevorConnectionOptions.KEYSTORE_PATH,
        EndevorConnectionOptions.EndevorConnectionOptions.KEYSTORE_PASS,
    ],
    examples: [
        {
            description: "Add client certificate to the Endevor connection MY-CONNECTION using the default EBG profile.",
            options: "MY-CONNECTION --login-url URL --type CERT_DATA --public-certificate PATH-TO-PUBLIC-CERTIFICATE --private-key PATH-TO-PRIVATE-KEY",
        },
        {
            description: "Add client certificate keystore to the Endevor connection MY-CONNECTION using the default EBG profile.",
            options: "MY-CONNECTION --login-url URL --type KEYSTORE --keystore-path KEYSTORE-PATH --keystore-password KEYSTORE-PASSWORD",
        },
    ],
};

exports.UpdateConnectionCertificateDefinition = UpdateConnectionCertificateDefinition;