@pnp/cli-microsoft365 4.3.0 → 4.4.0-beta.18b02d9

package/dist/Utils.js

@@ -51,6 +51,10 @@ class Utils {
         const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
         return guidRegEx.test(guid);
     }
+    static isValidTeamsChatId(guid) {
+        const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+(@thread\.v2|@unq\.gbl\.spaces)$/i);
+        return guidRegEx.test(guid);
+    }
     static isValidUserPrincipalName(upn) {
         const upnRegEx = new RegExp(/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/i);
         return upnRegEx.test(upn);

package/dist/cli/Cli.js

@@ -447,16 +447,14 @@ class Cli {
         }
         if (options.output === 'csv') {
             const { stringify } = require('csv-stringify/sync');
-            /*
-              https://csv.js.org/stringify/options/
-              header: Display the column names on the first line if the columns option is provided or discovered.
-              escape: Single character used for escaping; only apply to characters matching the quote and the escape options default to ".
-              quote: The quote characters surrounding a field, defaults to the " (double quotation marks), an empty quote value will preserve the original field, whether it contains quotation marks or not.
-              quoted: Boolean, default to false, quote all the non-empty fields even if not required.
-              quotedEmpty: Quote empty strings and overrides quoted_string on empty strings when defined; default is false.
-            */
+            const cli = Cli.getInstance();
+            // https://csv.js.org/stringify/options/
             return stringify(logStatement, {
-                header: true
+                header: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvHeader, true),
+                escape: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvEscape, '"'),
+                quote: cli.config.get(settingsNames_1.settingsNames.csvQuote),
+                quoted: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuoted, false),
+                quotedEmpty: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuotedEmpty, false)
             });
         }
         // display object as a list of key-value pairs

package/dist/m365/aad/commands/group/group-list.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.GROUP_LIST;
+    }
+    get description() {
+        return 'Lists all groups defined in Azure Active Directory.';
+    }
+    defaultProperties() {
+        return ['id', 'displayName', 'groupType'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAllItems(`${this.resource}/v1.0/groups`, logger, true)
+            .then(() => {
+            if (args.options.output === 'text') {
+                this.items.forEach((group) => {
+                    if (group.groupTypes && group.groupTypes.length > 0 && group.groupTypes[0] === 'Unified') {
+                        group.groupType = 'Microsoft 365';
+                    }
+                    else if (group.mailEnabled && group.securityEnabled) {
+                        group.groupType = 'Mail enabled security';
+                    }
+                    else if (group.securityEnabled) {
+                        group.groupType = 'Security';
+                    }
+                    else if (group.mailEnabled) {
+                        group.groupType = 'Distribution';
+                    }
+                });
+            }
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+}
+module.exports = new AadGroupListCommand();
+//# sourceMappingURL=group-list.js.map

package/dist/m365/aad/commands/user/user-hibp.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const AnonymousCommand_1 = require("../../../base/AnonymousCommand");
+const commands_1 = require("../../commands");
+class AadUserHibpCommand extends AnonymousCommand_1.default {
+    get name() {
+        return commands_1.default.USER_HIBP;
+    }
+    get description() {
+        return 'Allows you to retrieve all accounts that have been pwned with the specified username';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.domain = args.options.domain;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `https://haveibeenpwned.com/api/v3/breachedaccount/${encodeURIComponent(args.options.userName)}${(args.options.domain ? `?domain=${encodeURIComponent(args.options.domain)}` : '')}`,
+            headers: {
+                'accept': 'application/json',
+                'hibp-api-key': args.options.apiKey,
+                'x-anonymous': true
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        })
+            .catch((err) => {
+            if ((err && err.response !== undefined && err.response.status === 404) && (this.debug || this.verbose)) {
+                logger.log('No pwnage found');
+                cb();
+                return;
+            }
+            return this.handleRejectedODataJsonPromise(err, logger, cb);
+        });
+    }
+    options() {
+        const options = [
+            {
+                option: '-n, --userName <userName>'
+            },
+            {
+                option: '--apiKey, <apiKey>'
+            },
+            {
+                option: '--domain, [domain]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!Utils_1.default.isValidUserPrincipalName(args.options.userName)) {
+            return 'Specify valid userName';
+        }
+        return true;
+    }
+}
+module.exports = new AadUserHibpCommand();
+//# sourceMappingURL=user-hibp.js.map

package/dist/m365/aad/commands.js

@@ -11,6 +11,7 @@ exports.default = {
     APPROLEASSIGNMENT_ADD: `${prefix} approleassignment add`,
     APPROLEASSIGNMENT_LIST: `${prefix} approleassignment list`,
     APPROLEASSIGNMENT_REMOVE: `${prefix} approleassignment remove`,
+    GROUP_LIST: `${prefix} group list`,
     GROUPSETTING_ADD: `${prefix} groupsetting add`,
     GROUPSETTING_GET: `${prefix} groupsetting get`,
     GROUPSETTING_LIST: `${prefix} groupsetting list`,
@@ -50,6 +51,7 @@ exports.default = {
     SP_ADD: `${prefix} sp add`,
     SP_GET: `${prefix} sp get`,
     USER_GET: `${prefix} user get`,
+    USER_HIBP: `${prefix} user hibp`,
     USER_LIST: `${prefix} user list`,
     USER_PASSWORD_VALIDATE: `${prefix} user password validate`,
     USER_SET: `${prefix} user set`

package/dist/m365/cli/commands/config/config-set.js

@@ -21,6 +21,9 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         switch (args.options.key) {
             case settingsNames_1.settingsNames.showHelpOnFailure:
             case settingsNames_1.settingsNames.printErrorsAsPlainText:
+            case settingsNames_1.settingsNames.csvHeader:
+            case settingsNames_1.settingsNames.csvQuoted:
+            case settingsNames_1.settingsNames.csvQuotedEmpty:
                 value = args.options.value === 'true';
                 break;
             default:
@@ -47,7 +50,7 @@ class CliConfigSetCommand extends AnonymousCommand_1.default {
         if (CliConfigSetCommand.optionNames.indexOf(args.options.key) < 0) {
             return `${args.options.key} is not a valid setting. Allowed values: ${CliConfigSetCommand.optionNames.join(', ')}`;
         }
-        const allowedOutputs = ['text', 'json'];
+        const allowedOutputs = ['text', 'json', 'csv'];
         if (args.options.key === settingsNames_1.settingsNames.output &&
             allowedOutputs.indexOf(args.options.value) === -1) {
             return `${args.options.value} is not a valid value for the option ${args.options.key}. Allowed values: ${allowedOutputs.join(', ')}`;

package/dist/m365/pa/cds-project-mutator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const path = require("path");
-const xmldom_1 = require("xmldom");
+const xmldom_1 = require("@xmldom/xmldom");
 /*
  * Logic extracted from bolt.module.solution.dll
  * Version: 0.4.3

package/dist/m365/spo/commands/group/group-user-add.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("../../../../cli");
 const Command_1 = require("../../../../Command");
 const request_1 = require("../../../../request");
-const SpoCommand_1 = require("../../../base/SpoCommand");
 const AadUserGetCommand = require("../../../aad/commands/user/user-get");
+const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoGroupUserAddCommand extends SpoCommand_1.default {
     get name() {
@@ -17,15 +17,21 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         return ['DisplayName', 'Email'];
     }
     commandAction(logger, args, cb) {
-        this.getOnlyActiveUsers(args, logger)
+        let groupId = 0;
+        this
+            .getGroupId(args)
+            .then((_groupId) => {
+            groupId = _groupId;
+            return this.getOnlyActiveUsers(args, logger);
+        })
             .then((resolvedUsernameList) => {
             if (this.verbose) {
-                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId}...`);
+                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
             }
             const data = {
                 url: args.options.webUrl,
                 peoplePickerInput: this.getFormattedUserList(resolvedUsernameList),
-                roleValue: `group:${args.options.groupId}`
+                roleValue: `group:${groupId}`
             };
             const requestOptions = {
                 url: `${args.options.webUrl}/_api/SP.Web.ShareObject`,
@@ -46,24 +52,51 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
+    getGroupId(args) {
+        if (args.options.groupId) {
+            return Promise.resolve(args.options.groupId);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/GetByName('${encodeURIComponent(args.options.groupName)}')`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const groupId = response.Id;
+            if (!groupId) {
+                return Promise.reject(`The specified group not exist in the SharePoint site`);
+            }
+            return Promise.resolve(groupId);
+        });
+    }
     getOnlyActiveUsers(args, logger) {
         if (this.verbose) {
             logger.logToStderr(`Removing Users which are not active from the original list`);
         }
-        const activeUsernamelist = [];
-        return Promise.all(args.options.userName.split(",").map(singleUsername => {
+        const activeUserNameList = [];
+        const userInfo = args.options.userName ? args.options.userName : args.options.email;
+        return Promise.all(userInfo.split(',').map(singleUserName => {
             const options = {
-                userName: singleUsername.trim(),
                 output: 'json',
                 debug: args.options.debug,
                 verbose: args.options.verbose
             };
+            if (args.options.userName) {
+                options.userName = singleUserName.trim();
+            }
+            else {
+                options.email = singleUserName.trim();
+            }
             return cli_1.Cli.executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
                 .then((getUserGetOutput) => {
                 if (this.debug) {
                     logger.logToStderr(getUserGetOutput.stderr);
                 }
-                activeUsernamelist.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
+                activeUserNameList.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
             }, (err) => {
                 if (this.debug) {
                     logger.logToStderr(err.stderr);
@@ -71,7 +104,7 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
             });
         }))
             .then(() => {
-            return Promise.resolve(activeUsernamelist);
+            return Promise.resolve(activeUserNameList);
         });
     }
     getFormattedUserList(activeUserList) {
@@ -86,10 +119,16 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
                 option: '-u, --webUrl <webUrl>'
             },
             {
-                option: '--groupId <groupId>'
+                option: '--groupId [groupId]'
+            },
+            {
+                option: '--groupName [groupName]'
+            },
+            {
+                option: '--userName [userName]'
             },
             {
-                option: '--userName <userName>'
+                option: '--email [email]'
             }
         ];
         const parentOptions = super.options();
@@ -100,8 +139,20 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (typeof args.options.groupId !== 'number') {
-            return `Group Id : ${args.options.groupId} is not a number`;
+        if (!args.options.groupId && !args.options.groupName) {
+            return 'Specify either groupId or groupName';
+        }
+        if (args.options.groupId && args.options.groupName) {
+            return 'Specify either groupId or groupName but not both';
+        }
+        if (!args.options.userName && !args.options.email) {
+            return 'Specify either userName or email';
+        }
+        if (args.options.userName && args.options.email) {
+            return 'Specify either userName or email but not both';
+        }
+        if (args.options.groupId && isNaN(args.options.groupId)) {
+            return `Specified groupId ${args.options.groupId} is not a number`;
         }
         return true;
     }

package/dist/m365/teams/commands/app/app-list.js

@@ -25,24 +25,27 @@ class TeamsAppListCommand extends GraphItemsListCommand_1.GraphItemsListCommand
         if (args.options.teamId) {
             return Promise.resolve(args.options.teamId);
         }
-        const teamRequestOptions = {
-            url: `${this.resource}/v1.0/me/joinedTeams?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
+        const requestOptions = {
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
         return request_1.default
-            .get(teamRequestOptions)
+            .get(requestOptions)
             .then(response => {
-            const teamItem = response.value[0];
-            if (!teamItem) {
+            const groupItem = response.value[0];
+            if (!groupItem) {
+                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+            }
+            if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
                 return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
             }
             if (response.value.length > 1) {
                 return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
             }
-            return Promise.resolve(teamItem.id);
+            return Promise.resolve(groupItem.id);
         });
     }
     getEndpointUrl(args) {

package/dist/m365/teams/commands/chat/chat-list.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TeamsChatListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.CHAT_LIST;
+    }
+    get description() {
+        return 'Lists all chat conversations';
+    }
+    defaultProperties() {
+        return ['id', 'topic', 'chatType'];
+    }
+    commandAction(logger, args, cb) {
+        const filter = args.options.type !== undefined ? `?$filter=chatType eq '${args.options.type}'` : '';
+        const endpoint = `${this.resource}/v1.0/chats${filter}`;
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-t, --type [chatType]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const supportedTypes = ['oneOnOne', 'group', 'meeting'];
+        if (args.options.type !== undefined && supportedTypes.indexOf(args.options.type) === -1) {
+            return `${args.options.type} is not a valid chatType. Accepted values are ${supportedTypes.join(', ')}`;
+        }
+        return true;
+    }
+}
+module.exports = new TeamsChatListCommand();
+//# sourceMappingURL=chat-list.js.map

package/dist/m365/teams/commands/chat/chat-member-list.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils_1 = require("../../../../Utils");
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TeamsChatMemberListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.CHAT_MEMBER_LIST;
+    }
+    get description() {
+        return 'Lists all members from a chat';
+    }
+    defaultProperties() {
+        return ['userId', 'displayName', 'email'];
+    }
+    commandAction(logger, args, cb) {
+        const endpoint = `${this.resource}/v1.0/chats/${args.options.chatId}/members`;
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --chatId <chatId>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!Utils_1.default.isValidTeamsChatId(args.options.chatId)) {
+            return `${args.options.chatId} is not a valid Teams ChatId`;
+        }
+        return true;
+    }
+}
+module.exports = new TeamsChatMemberListCommand();
+//# sourceMappingURL=chat-member-list.js.map

package/dist/m365/teams/commands/chat/chat-message-list.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utils_1 = require("../../../../Utils");
+const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
+const commands_1 = require("../../commands");
+class TeamsChatMessageListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
+    get name() {
+        return commands_1.default.CHAT_MESSAGE_LIST;
+    }
+    get description() {
+        return 'Lists all messages from a chat';
+    }
+    defaultProperties() {
+        return ['id', 'shortBody'];
+    }
+    commandAction(logger, args, cb) {
+        const endpoint = `${this.resource}/v1.0/chats/${args.options.chatId}/messages`;
+        this
+            .getAllItems(endpoint, logger, true)
+            .then(() => {
+            if (args.options.output !== 'json') {
+                this.items.forEach(i => {
+                    // hoist the content to body for readability
+                    i.body = i.body.content;
+                    let shortBody;
+                    const bodyToProcess = i.body;
+                    if (bodyToProcess) {
+                        let maxLength = 50;
+                        let addedDots = '...';
+                        if (bodyToProcess.length < maxLength) {
+                            maxLength = bodyToProcess.length;
+                            addedDots = '';
+                        }
+                        shortBody = bodyToProcess.replace(/\n/g, ' ').substring(0, maxLength) + addedDots;
+                    }
+                    i.shortBody = shortBody;
+                });
+            }
+            logger.log(this.items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --chatId <chatId>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!Utils_1.default.isValidTeamsChatId(args.options.chatId)) {
+            return `${args.options.chatId} is not a valid Teams chat ID`;
+        }
+        return true;
+    }
+}
+module.exports = new TeamsChatMessageListCommand();
+//# sourceMappingURL=chat-message-list.js.map

package/dist/m365/teams/commands/tab/tab-get.js

@@ -30,24 +30,27 @@ class TeamsTabGetCommand extends GraphCommand_1.default {
         if (args.options.teamId) {
             return Promise.resolve(args.options.teamId);
         }
-        const teamRequestOptions = {
-            url: `${this.resource}/v1.0/me/joinedTeams?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
+        const requestOptions = {
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(args.options.teamName)}'`,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
         return request_1.default
-            .get(teamRequestOptions)
+            .get(requestOptions)
             .then(response => {
-            const teamItem = response.value[0];
-            if (!teamItem) {
+            const groupItem = response.value[0];
+            if (!groupItem) {
+                return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
+            }
+            if (groupItem.resourceProvisioningOptions.indexOf('Team') === -1) {
                 return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
             }
             if (response.value.length > 1) {
                 return Promise.reject(`Multiple Microsoft Teams teams with name ${args.options.teamName} found: ${response.value.map(x => x.id)}`);
             }
-            return Promise.resolve(teamItem.id);
+            return Promise.resolve(groupItem.id);
         });
     }
     getChannelId(args) {

package/dist/m365/teams/commands.js

@@ -13,6 +13,9 @@ exports.default = {
     CHANNEL_LIST: `${prefix} channel list`,
     CHANNEL_REMOVE: `${prefix} channel remove`,
     CHANNEL_SET: `${prefix} channel set`,
+    CHAT_LIST: `${prefix} chat list`,
+    CHAT_MEMBER_LIST: `${prefix} chat member list`,
+    CHAT_MESSAGE_LIST: `${prefix} chat message list`,
     CONVERSATIONMEMBER_ADD: `${prefix} conversationmember add`,
     CONVERSATIONMEMBER_LIST: `${prefix} conversationmember list`,
     FUNSETTINGS_LIST: `${prefix} funsettings list`,

package/dist/settingsNames.js

@@ -5,7 +5,12 @@ const settingsNames = {
     errorOutput: 'errorOutput',
     output: 'output',
     printErrorsAsPlainText: 'printErrorsAsPlainText',
-    showHelpOnFailure: 'showHelpOnFailure'
+    showHelpOnFailure: 'showHelpOnFailure',
+    csvHeader: 'csvHeader',
+    csvEscape: 'csvEscape',
+    csvQuote: 'csvQuote',
+    csvQuoted: 'csvQuoted',
+    csvQuotedEmpty: 'csvQuotedEmpty'
 };
 exports.settingsNames = settingsNames;
 //# sourceMappingURL=settingsNames.js.map

package/docs/docs/cmd/aad/group/group-list.md

@@ -0,0 +1,21 @@
+# aad group list
+
+Lists Azure AD groups
+
+## Usage
+
+```sh
+m365 aad group list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Lists all groups defined in Azure Active Directory.
+
+```sh
+m365 aad group list
+```

package/docs/docs/cmd/aad/user/user-hibp.md

@@ -0,0 +1,46 @@
+# aad user hibp
+
+Allows you to retrieve all accounts that have been pwned with the specified username
+
+## Usage
+
+```sh
+m365 aad user hibp [options]
+```
+
+## Options
+
+`-n, --userName <userName>`
+: The name of the user to retrieve information for.
+
+`--apiKey, <apiKey>`
+: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
+
+`--domain, [domain]`
+: Limit the returned breaches only contain results with the domain specified.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
+
+If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
+
+## Examples
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
+```
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
+```
+
+## More information
+
+- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)