@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/list/list-user/ListUser.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

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

/*
 * Copyright (c) 2019 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 ListUserDefinition = {
    name: "user",
    aliases: ["u", "users"],
    type: "command",
    handler: __dirname + "/ListUser.handler",
    description: "List users",
    summary: "List users",
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE],
    },
    positionals: [EBGOptions.EBGOptions.USER],
    options: [PageableOptions.PageableOptions.PAGE, PageableOptions.PageableOptions.SIZE],
    outputFormatOptions: true,
    examples: [
        {
            description: "Use the default EBG profile to list all Bridge for Git users.",
            options: "",
        },
        {
            description: "List specific number of users using the default EBG profile",
            options: "OPERATION-ID --size 5",
        },
        {
            description: "Use the default EBG profile to list current user.",
            options: "me",
        },
        {
            description: "Use the default EBG profile to list use USERNAME.",
            options: "USERNAME",
        },
        {
            description: "List all the Bridge for Git users without an EBG profile.",
            options: "--protocol http --host my-host --port 8080 --user my-git-username --token 1234567890",
        },
    ],
};

exports.ListUserDefinition = ListUserDefinition;