@pnp/cli-microsoft365 5.0.0-beta.a1bb50f → 5.0.0-beta.c98b96c

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) {
+        const getGroupMethod = args.options.groupName ?
+            `GetByName('${encodeURIComponent(args.options.groupName)}')` :
+            `GetById('${args.options.groupId}')`;
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/${getGroupMethod}`,
+            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 does not exist in the SharePoint site`);
+            }
+            return 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: '--userName <userName>'
+                option: '--groupName [groupName]'
+            },
+            {
+                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/spo/commands/site/site-recyclebinitem-list.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoSiteRecycleBinItemListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.SITE_RECYCLEBINITEM_LIST;
+    }
+    get description() {
+        return 'Lists items from recycle bin';
+    }
+    defaultProperties() {
+        return ['Id', 'Title', 'DirName'];
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving all items from recycle bin at ${args.options.siteUrl}...`);
+        }
+        const state = args.options.secondary ? '2' : '1';
+        let requestUrl = `${args.options.siteUrl}/_api/site/RecycleBin?$filter=(ItemState eq ${state})`;
+        if (typeof args.options.type !== 'undefined') {
+            const type = SpoSiteRecycleBinItemListCommand.recycleBinItemType.find(item => item.value === args.options.type);
+            if (typeof type !== 'undefined') {
+                requestUrl += ` and (ItemType eq ${type.id})`;
+            }
+        }
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            logger.log(response.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --siteUrl <siteUrl>'
+            },
+            {
+                option: '-t, --type [type]',
+                autocomplete: SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value)
+            },
+            {
+                option: '-s, --secondary'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.siteUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (typeof args.options.type !== 'undefined' &&
+            !SpoSiteRecycleBinItemListCommand.recycleBinItemType.some(item => item.value === args.options.type)) {
+            return `${args.options.type} is not a valid value. Allowed values are ${SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value).join(', ')}`;
+        }
+        return true;
+    }
+}
+SpoSiteRecycleBinItemListCommand.recycleBinItemType = [
+    { id: 1, value: 'files' },
+    { id: 3, value: 'listItems' },
+    { id: 5, value: 'folders' }
+];
+module.exports = new SpoSiteRecycleBinItemListCommand();
+//# sourceMappingURL=site-recyclebinitem-list.js.map

package/dist/m365/spo/commands.js

@@ -183,6 +183,7 @@ exports.default = {
     SITE_GROUPIFY: `${prefix} site groupify`,
     SITE_LIST: `${prefix} site list`,
     SITE_INPLACERECORDSMANAGEMENT_SET: `${prefix} site inplacerecordsmanagement set`,
+    SITE_RECYCLEBINITEM_LIST: `${prefix} site recyclebinitem list`,
     SITE_REMOVE: `${prefix} site remove`,
     SITE_RENAME: `${prefix} site rename`,
     SITE_SET: `${prefix} site set`,

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/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const request_1 = require("../../../../request");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_GET;
+    }
+    get description() {
+        return 'This operation provides the health information of a specified service for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.issues = typeof args.options.issues !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'status', 'service'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getServiceHealth(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getServiceHealth(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews/${options.serviceName}${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const serviceHealth = response;
+            if (!serviceHealth) {
+                return Promise.reject(`Error fetching service health`);
+            }
+            return Promise.resolve(serviceHealth);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-s, --serviceName <serviceName>' },
+            { option: '-i, --issues' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthGetCommand();
+//# sourceMappingURL=serviceannouncement-health-get.js.map

package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const request_1 = require("../../../../request");
+const commands_1 = require("../../commands");
+class TenantServiceAnnouncementHealthListCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.SERVICEANNOUNCEMENT_HEALTH_LIST;
+    }
+    get description() {
+        return 'This operation provides the health report of all subscribed services for a tenant';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.issues = typeof args.options.issues !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['id', 'status', 'service'];
+    }
+    commandAction(logger, args, cb) {
+        this
+            .listServiceHealth(args.options)
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    listServiceHealth(options) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/serviceAnnouncement/healthOverviews${options.issues && (!options.output || options.output.toLocaleLowerCase() === 'json') ? '?$expand=issues' : ''}`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const serviceHealthList = response.value;
+            if (!serviceHealthList) {
+                return Promise.reject(`Error fetching service health`);
+            }
+            return Promise.resolve(serviceHealthList);
+        });
+    }
+    options() {
+        const options = [
+            { option: '-i, --issues' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+}
+module.exports = new TenantServiceAnnouncementHealthListCommand();
+//# sourceMappingURL=serviceannouncement-health-list.js.map

package/dist/m365/tenant/commands.js

@@ -13,6 +13,8 @@ exports.default = {
     SERVICE_LIST: `${prefix} service list`,
     SERVICE_MESSAGE_LIST: `${prefix} service message list`,
     SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
+    SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
+    SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
     STATUS_LIST: `${prefix} status list`
 };
 //# sourceMappingURL=commands.js.map

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/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)