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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/.devcontainer/devcontainer.json +9 -1
  2. package/dist/Utils.js +7 -0
  3. package/dist/cli/Cli.js +20 -3
  4. package/dist/m365/aad/commands/group/group-list.js +41 -0
  5. package/dist/m365/aad/commands/o365group/{Group.js → GroupExtended.js} +1 -1
  6. package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
  7. package/dist/m365/aad/commands/user/user-get.js +33 -6
  8. package/dist/m365/aad/commands/user/user-hibp.js +67 -0
  9. package/dist/m365/aad/commands.js +2 -0
  10. package/dist/m365/app/commands/permission/permission-list.js +266 -0
  11. package/dist/m365/app/commands.js +7 -0
  12. package/dist/m365/base/AppCommand.js +76 -0
  13. package/dist/m365/cli/commands/config/config-set.js +4 -1
  14. package/dist/m365/flow/commands/flow-get.js +2 -2
  15. package/dist/m365/pa/cds-project-mutator.js +1 -1
  16. package/dist/m365/pa/commands/app/app-list.js +28 -1
  17. package/dist/m365/{aad/commands/o365group/GroupUser.js → planner/AppliedCategories.js} +1 -1
  18. package/dist/m365/planner/commands/task/task-add.js +288 -0
  19. package/dist/m365/planner/commands/task/task-set.js +357 -0
  20. package/dist/m365/planner/commands.js +3 -1
  21. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
  22. package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.14.0-beta.4.js → upgrade-1.14.0-beta.5.js} +27 -25
  23. package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
  24. package/dist/m365/spo/commands/group/group-user-add.js +64 -13
  25. package/dist/m365/spo/commands/site/site-ensure.js +1 -1
  26. package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
  27. package/dist/m365/spo/commands.js +1 -0
  28. package/dist/m365/teams/commands/app/app-list.js +9 -6
  29. package/dist/m365/teams/commands/chat/chat-list.js +43 -0
  30. package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
  31. package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
  32. package/dist/m365/teams/commands/message/message-get.js +1 -1
  33. package/dist/m365/teams/commands/tab/tab-get.js +9 -6
  34. package/dist/m365/teams/commands.js +3 -0
  35. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
  36. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
  37. package/dist/m365/tenant/commands.js +2 -0
  38. package/dist/request.js +6 -3
  39. package/dist/settingsNames.js +6 -1
  40. package/docs/docs/cmd/_global.md +2 -2
  41. package/docs/docs/cmd/aad/group/group-list.md +21 -0
  42. package/docs/docs/cmd/aad/user/user-get.md +13 -4
  43. package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
  44. package/docs/docs/cmd/app/permission/permission-list.md +36 -0
  45. package/docs/docs/cmd/pa/app/app-list.md +17 -1
  46. package/docs/docs/cmd/planner/task/task-add.md +78 -0
  47. package/docs/docs/cmd/planner/task/task-set.md +99 -0
  48. package/docs/docs/cmd/spfx/project/project-externalize.md +1 -1
  49. package/docs/docs/cmd/spfx/project/project-rename.md +1 -1
  50. package/docs/docs/cmd/spfx/spfx-doctor.md +1 -1
  51. package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
  52. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
  53. package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
  54. package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
  55. package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
  56. package/docs/docs/cmd/teams/message/message-get.md +0 -3
  57. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
  58. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
  59. package/npm-shrinkwrap.json +270 -360
  60. package/package.json +21 -17
@@ -2,7 +2,15 @@
2
2
  "name": "CLI for Microsoft 365",
3
3
  "dockerFile": "Dockerfile",
4
4
  "settings": {
5
- "terminal.integrated.shell.linux": "/bin/zsh"
5
+ "terminal.integrated.profiles.linux": {
6
+ "zsh": {
7
+ "path": "/bin/zsh",
8
+ "args": [
9
+ "-l"
10
+ ]
11
+ }
12
+ },
13
+ "terminal.integrated.defaultProfile.linux": "zsh"
6
14
  },
7
15
  "postCreateCommand": "npm i && npm run clean && npm run build && npm link",
8
16
  "extensions": [
package/dist/Utils.js CHANGED
@@ -40,6 +40,9 @@ class Utils {
40
40
  }
41
41
  });
42
42
  }
43
+ static isValidGuidArray(guids) {
44
+ return guids.every(guid => this.isValidGuid(guid));
45
+ }
43
46
  static isValidGuid(guid) {
44
47
  const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
45
48
  return guidRegEx.test(guid);
@@ -48,6 +51,10 @@ class Utils {
48
51
  const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
49
52
  return guidRegEx.test(guid);
50
53
  }
54
+ static isValidTeamsChatId(guid) {
55
+ const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+(@thread\.v2|@unq\.gbl\.spaces)$/i);
56
+ return guidRegEx.test(guid);
57
+ }
51
58
  static isValidUserPrincipalName(upn) {
52
59
  const upnRegEx = new RegExp(/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/i);
53
60
  return upnRegEx.test(upn);
package/dist/cli/Cli.js CHANGED
@@ -17,6 +17,7 @@ const path = require("path");
17
17
  const appInsights_1 = require("../appInsights");
18
18
  const Command_1 = require("../Command");
19
19
  const config_1 = require("../config");
20
+ const request_1 = require("../request");
20
21
  const settingsNames_1 = require("../settingsNames");
21
22
  const Utils_1 = require("../Utils");
22
23
  const packageJSON = require('../../package.json');
@@ -204,16 +205,20 @@ class Cli {
204
205
  }
205
206
  };
206
207
  if (args.options.debug) {
207
- Cli.log(`Executing command ${command.name} with options ${JSON.stringify(args)}`);
208
+ logErr.push(`Executing command ${command.name} with options ${JSON.stringify(args)}`);
208
209
  }
209
210
  // store the current command name, if any and set the name to the name of
210
211
  // the command to execute
211
212
  const cli = Cli.getInstance();
212
213
  const parentCommandName = cli.currentCommandName;
213
214
  cli.currentCommandName = command.getCommandName();
215
+ // store the current logger if any
216
+ const currentLogger = request_1.default.logger;
214
217
  command.action(logger, args, (err) => {
215
218
  // restore the original command name
216
219
  cli.currentCommandName = parentCommandName;
220
+ // restore the original logger
221
+ request_1.default.logger = currentLogger;
217
222
  if (err) {
218
223
  return reject({
219
224
  error: err,
@@ -416,11 +421,11 @@ class Cli {
416
421
  if (arrayType !== 'object') {
417
422
  return logStatement.join(os.EOL);
418
423
  }
419
- // if output type has been set to 'text', process the retrieved
424
+ // if output type has been set to 'text' or 'csv', process the retrieved
420
425
  // data so that returned objects contain only default properties specified
421
426
  // on the current command. If there is no current command or the
422
427
  // command doesn't specify default properties, return original data
423
- if (options.output === 'text') {
428
+ if (options.output === 'text' || options.output === 'csv') {
424
429
  const cli = Cli.getInstance();
425
430
  const currentCommand = cli.commandToExecute;
426
431
  if (arrayType === 'object' &&
@@ -440,6 +445,18 @@ class Cli {
440
445
  }
441
446
  }
442
447
  }
448
+ if (options.output === 'csv') {
449
+ const { stringify } = require('csv-stringify/sync');
450
+ const cli = Cli.getInstance();
451
+ // https://csv.js.org/stringify/options/
452
+ return stringify(logStatement, {
453
+ header: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvHeader, true),
454
+ escape: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvEscape, '"'),
455
+ quote: cli.config.get(settingsNames_1.settingsNames.csvQuote),
456
+ quoted: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuoted, false),
457
+ quotedEmpty: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuotedEmpty, false)
458
+ });
459
+ }
443
460
  // display object as a list of key-value pairs
444
461
  if (logStatement.length === 1) {
445
462
  const obj = logStatement[0];
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const GraphItemsListCommand_1 = require("../../../base/GraphItemsListCommand");
4
+ const commands_1 = require("../../commands");
5
+ class AadGroupListCommand extends GraphItemsListCommand_1.GraphItemsListCommand {
6
+ get name() {
7
+ return commands_1.default.GROUP_LIST;
8
+ }
9
+ get description() {
10
+ return 'Lists all groups defined in Azure Active Directory.';
11
+ }
12
+ defaultProperties() {
13
+ return ['id', 'displayName', 'groupType'];
14
+ }
15
+ commandAction(logger, args, cb) {
16
+ this
17
+ .getAllItems(`${this.resource}/v1.0/groups`, logger, true)
18
+ .then(() => {
19
+ if (args.options.output === 'text') {
20
+ this.items.forEach((group) => {
21
+ if (group.groupTypes && group.groupTypes.length > 0 && group.groupTypes[0] === 'Unified') {
22
+ group.groupType = 'Microsoft 365';
23
+ }
24
+ else if (group.mailEnabled && group.securityEnabled) {
25
+ group.groupType = 'Mail enabled security';
26
+ }
27
+ else if (group.securityEnabled) {
28
+ group.groupType = 'Security';
29
+ }
30
+ else if (group.mailEnabled) {
31
+ group.groupType = 'Distribution';
32
+ }
33
+ });
34
+ }
35
+ logger.log(this.items);
36
+ cb();
37
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
38
+ }
39
+ }
40
+ module.exports = new AadGroupListCommand();
41
+ //# sourceMappingURL=group-list.js.map
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=Group.js.map
3
+ //# sourceMappingURL=GroupExtended.js.map
@@ -37,14 +37,14 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
37
37
  logger.logToStderr(this.items);
38
38
  logger.logToStderr('');
39
39
  }
40
- if (this.items.filter(i => i.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase()).length <= 0) {
40
+ if (this.items.filter(i => args.options.userName.toUpperCase() === i.userPrincipalName.toUpperCase()).length <= 0) {
41
41
  const userNotInGroup = (typeof args.options.groupId !== 'undefined') ?
42
42
  'The specified user does not belong to the given Microsoft 365 Group. Please use the \'o365group user add\' command to add new users.' :
43
43
  'The specified user does not belong to the given Microsoft Teams team. Please use the \'graph teams user add\' command to add new users.';
44
44
  throw new Error(userNotInGroup);
45
45
  }
46
46
  if (args.options.role === "Owner") {
47
- const foundMember = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Member');
47
+ const foundMember = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Member');
48
48
  if (foundMember !== undefined) {
49
49
  const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/$ref`;
50
50
  const requestOptions = {
@@ -65,7 +65,7 @@ class AadO365GroupUserSetCommand extends GraphItemsListCommand_1.GraphItemsListC
65
65
  }
66
66
  }
67
67
  else {
68
- const foundOwner = this.items.find(e => e.userPrincipalName.toLocaleLowerCase() === args.options.userName.toLocaleLowerCase() && e.userType === 'Owner');
68
+ const foundOwner = this.items.find(e => args.options.userName.toUpperCase() === e.userPrincipalName.toUpperCase() && e.userType === 'Owner');
69
69
  if (foundOwner !== undefined) {
70
70
  const endpoint = `${this.resource}/v1.0/groups/${groupId}/owners/${foundOwner.id}/$ref`;
71
71
  const requestOptions = {
@@ -20,10 +20,20 @@ class AadUserGetCommand extends GraphCommand_1.default {
20
20
  }
21
21
  commandAction(logger, args, cb) {
22
22
  const properties = args.options.properties ?
23
- `?$select=${args.options.properties.split(',').map(p => encodeURIComponent(p.trim())).join(',')}` :
23
+ `&$select=${args.options.properties.split(',').map(p => encodeURIComponent(p.trim())).join(',')}` :
24
24
  '';
25
+ let requestUrl = `${this.resource}/v1.0/users`;
26
+ if (args.options.id) {
27
+ requestUrl += `?$filter=id eq '${encodeURIComponent(args.options.id)}'${properties}`;
28
+ }
29
+ else if (args.options.userName) {
30
+ requestUrl += `?$filter=userPrincipalName eq '${encodeURIComponent(args.options.userName)}'${properties}`;
31
+ }
32
+ else if (args.options.email) {
33
+ requestUrl += `?$filter=mail eq '${encodeURIComponent(args.options.email)}'${properties}`;
34
+ }
25
35
  const requestOptions = {
26
- url: `${this.resource}/v1.0/users/${encodeURIComponent(args.options.id ? args.options.id : args.options.userName)}${properties}`,
36
+ url: requestUrl,
27
37
  headers: {
28
38
  accept: 'application/json;odata.metadata=none'
29
39
  },
@@ -31,6 +41,18 @@ class AadUserGetCommand extends GraphCommand_1.default {
31
41
  };
32
42
  request_1.default
33
43
  .get(requestOptions)
44
+ .then((res) => {
45
+ if (res.value.length === 1) {
46
+ return Promise.resolve(res.value[0]);
47
+ }
48
+ const identifier = args.options.id ? `id ${args.options.id}`
49
+ : args.options.userName ? `user name ${args.options.userName}`
50
+ : `email ${args.options.email}`;
51
+ if (res.value.length === 0) {
52
+ return Promise.reject(`The specified user with ${identifier} does not exist`);
53
+ }
54
+ return Promise.reject(`Multiple users with ${identifier} found. Please disambiguate (user names): ${res.value.map(a => a.userPrincipalName).join(', ')} or (ids): ${res.value.map(a => a.id).join(', ')}`);
55
+ })
34
56
  .then((res) => {
35
57
  logger.log(res);
36
58
  cb();
@@ -44,6 +66,9 @@ class AadUserGetCommand extends GraphCommand_1.default {
44
66
  {
45
67
  option: '-n, --userName [userName]'
46
68
  },
69
+ {
70
+ option: '--email [email]'
71
+ },
47
72
  {
48
73
  option: '-p, --properties [properties]'
49
74
  }
@@ -52,11 +77,13 @@ class AadUserGetCommand extends GraphCommand_1.default {
52
77
  return options.concat(parentOptions);
53
78
  }
54
79
  validate(args) {
55
- if (!args.options.id && !args.options.userName) {
56
- return 'Specify either id or userName';
80
+ if (!args.options.id && !args.options.userName && !args.options.email) {
81
+ return 'Specify id, userName or email, one is required';
57
82
  }
58
- if (args.options.id && args.options.userName) {
59
- return 'Specify either id or userName but not both';
83
+ if ((args.options.id && args.options.email) ||
84
+ (args.options.id && args.options.userName) ||
85
+ (args.options.userName && args.options.email)) {
86
+ return 'Use either id, userName or email, but not all';
60
87
  }
61
88
  if (args.options.id &&
62
89
  !Utils_1.default.isValidGuid(args.options.id)) {
@@ -0,0 +1,67 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const Utils_1 = require("../../../../Utils");
5
+ const AnonymousCommand_1 = require("../../../base/AnonymousCommand");
6
+ const commands_1 = require("../../commands");
7
+ class AadUserHibpCommand extends AnonymousCommand_1.default {
8
+ get name() {
9
+ return commands_1.default.USER_HIBP;
10
+ }
11
+ get description() {
12
+ return 'Allows you to retrieve all accounts that have been pwned with the specified username';
13
+ }
14
+ getTelemetryProperties(args) {
15
+ const telemetryProps = super.getTelemetryProperties(args);
16
+ telemetryProps.domain = args.options.domain;
17
+ return telemetryProps;
18
+ }
19
+ commandAction(logger, args, cb) {
20
+ const requestOptions = {
21
+ url: `https://haveibeenpwned.com/api/v3/breachedaccount/${encodeURIComponent(args.options.userName)}${(args.options.domain ? `?domain=${encodeURIComponent(args.options.domain)}` : '')}`,
22
+ headers: {
23
+ 'accept': 'application/json',
24
+ 'hibp-api-key': args.options.apiKey,
25
+ 'x-anonymous': true
26
+ },
27
+ responseType: 'json'
28
+ };
29
+ request_1.default
30
+ .get(requestOptions)
31
+ .then((res) => {
32
+ logger.log(res);
33
+ cb();
34
+ })
35
+ .catch((err) => {
36
+ if ((err && err.response !== undefined && err.response.status === 404) && (this.debug || this.verbose)) {
37
+ logger.log('No pwnage found');
38
+ cb();
39
+ return;
40
+ }
41
+ return this.handleRejectedODataJsonPromise(err, logger, cb);
42
+ });
43
+ }
44
+ options() {
45
+ const options = [
46
+ {
47
+ option: '-n, --userName <userName>'
48
+ },
49
+ {
50
+ option: '--apiKey, <apiKey>'
51
+ },
52
+ {
53
+ option: '--domain, [domain]'
54
+ }
55
+ ];
56
+ const parentOptions = super.options();
57
+ return options.concat(parentOptions);
58
+ }
59
+ validate(args) {
60
+ if (!Utils_1.default.isValidUserPrincipalName(args.options.userName)) {
61
+ return 'Specify valid userName';
62
+ }
63
+ return true;
64
+ }
65
+ }
66
+ module.exports = new AadUserHibpCommand();
67
+ //# sourceMappingURL=user-hibp.js.map
@@ -11,6 +11,7 @@ exports.default = {
11
11
  APPROLEASSIGNMENT_ADD: `${prefix} approleassignment add`,
12
12
  APPROLEASSIGNMENT_LIST: `${prefix} approleassignment list`,
13
13
  APPROLEASSIGNMENT_REMOVE: `${prefix} approleassignment remove`,
14
+ GROUP_LIST: `${prefix} group list`,
14
15
  GROUPSETTING_ADD: `${prefix} groupsetting add`,
15
16
  GROUPSETTING_GET: `${prefix} groupsetting get`,
16
17
  GROUPSETTING_LIST: `${prefix} groupsetting list`,
@@ -50,6 +51,7 @@ exports.default = {
50
51
  SP_ADD: `${prefix} sp add`,
51
52
  SP_GET: `${prefix} sp get`,
52
53
  USER_GET: `${prefix} user get`,
54
+ USER_HIBP: `${prefix} user hibp`,
53
55
  USER_LIST: `${prefix} user list`,
54
56
  USER_PASSWORD_VALIDATE: `${prefix} user password validate`,
55
57
  USER_SET: `${prefix} user set`
@@ -0,0 +1,266 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const cli_1 = require("../../../../cli");
13
+ const request_1 = require("../../../../request");
14
+ const appGetCommand = require("../../../aad/commands/app/app-get");
15
+ const AppCommand_1 = require("../../../base/AppCommand");
16
+ const commands_1 = require("../../commands");
17
+ var GetServicePrincipal;
18
+ (function (GetServicePrincipal) {
19
+ GetServicePrincipal[GetServicePrincipal["withPermissions"] = 0] = "withPermissions";
20
+ GetServicePrincipal[GetServicePrincipal["withPermissionDefinitions"] = 1] = "withPermissionDefinitions";
21
+ })(GetServicePrincipal || (GetServicePrincipal = {}));
22
+ class AppPermissionListCommand extends AppCommand_1.default {
23
+ get name() {
24
+ return commands_1.default.PERMISSION_LIST;
25
+ }
26
+ get description() {
27
+ return 'Lists API permissions for the current AAD app';
28
+ }
29
+ commandAction(logger, args, cb) {
30
+ this
31
+ .getServicePrincipal({ appId: this.appId }, logger, GetServicePrincipal.withPermissions)
32
+ .then(servicePrincipal => {
33
+ if (servicePrincipal) {
34
+ // service principal found, get permissions from the service principal
35
+ return this.getServicePrincipalPermissions(servicePrincipal, logger);
36
+ }
37
+ else {
38
+ // service principal not found, get permissions from app registration
39
+ return this.getAppRegPermissions(this.appId, logger);
40
+ }
41
+ })
42
+ .then(permissions => {
43
+ logger.log(permissions);
44
+ cb();
45
+ }, err => this.handleRejectedODataJsonPromise(err, logger, cb));
46
+ }
47
+ getServicePrincipal(servicePrincipalInfo, logger, mode) {
48
+ var _a;
49
+ return __awaiter(this, void 0, void 0, function* () {
50
+ if (this.verbose) {
51
+ logger.logToStderr(`Retrieving service principal ${(_a = servicePrincipalInfo.appId) !== null && _a !== void 0 ? _a : servicePrincipalInfo.id}`);
52
+ }
53
+ const lookupUrl = servicePrincipalInfo.appId ? `?$filter=appId eq '${servicePrincipalInfo.appId}'&` : `/${servicePrincipalInfo.id}?`;
54
+ const requestOptions = {
55
+ url: `${this.resource}/v1.0/servicePrincipals${lookupUrl}$select=appId,id,displayName`,
56
+ headers: {
57
+ accept: 'application/json;odata.metadata=none'
58
+ },
59
+ responseType: 'json'
60
+ };
61
+ const response = yield request_1.default.get(requestOptions);
62
+ if ((servicePrincipalInfo.id && !response) ||
63
+ (servicePrincipalInfo.appId && response.value.length === 0)) {
64
+ return undefined;
65
+ }
66
+ const servicePrincipal = servicePrincipalInfo.appId ?
67
+ response.value[0] :
68
+ response;
69
+ if (this.verbose) {
70
+ logger.logToStderr(`Retrieving permissions for service principal ${servicePrincipal.id}...`);
71
+ }
72
+ const permissionsPromises = [];
73
+ switch (mode) {
74
+ case GetServicePrincipal.withPermissions:
75
+ const appRoleAssignmentsRequestOptions = {
76
+ url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/appRoleAssignments`,
77
+ headers: {
78
+ accept: 'application/json;odata.metadata=none'
79
+ },
80
+ responseType: 'json'
81
+ };
82
+ const oauth2PermissionGrantsRequestOptions = {
83
+ url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/oauth2PermissionGrants`,
84
+ headers: {
85
+ accept: 'application/json;odata.metadata=none'
86
+ },
87
+ responseType: 'json'
88
+ };
89
+ permissionsPromises.push(...[
90
+ request_1.default.get(appRoleAssignmentsRequestOptions),
91
+ request_1.default.get(oauth2PermissionGrantsRequestOptions)
92
+ ]);
93
+ break;
94
+ case GetServicePrincipal.withPermissionDefinitions:
95
+ const oauth2PermissionScopesRequestOptions = {
96
+ url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/oauth2PermissionScopes`,
97
+ headers: {
98
+ accept: 'application/json;odata.metadata=none'
99
+ },
100
+ responseType: 'json'
101
+ };
102
+ const appRolesRequestOptions = {
103
+ url: `${this.resource}/v1.0/servicePrincipals/${servicePrincipal.id}/appRoles`,
104
+ headers: {
105
+ accept: 'application/json;odata.metadata=none'
106
+ },
107
+ responseType: 'json'
108
+ };
109
+ permissionsPromises.push(...[
110
+ request_1.default.get(oauth2PermissionScopesRequestOptions),
111
+ request_1.default.get(appRolesRequestOptions)
112
+ ]);
113
+ break;
114
+ }
115
+ const permissions = yield Promise.all(permissionsPromises);
116
+ switch (mode) {
117
+ case GetServicePrincipal.withPermissions:
118
+ servicePrincipal.appRoleAssignments = permissions[0].value;
119
+ servicePrincipal.oauth2PermissionGrants = permissions[1].value;
120
+ break;
121
+ case GetServicePrincipal.withPermissionDefinitions:
122
+ servicePrincipal.oauth2PermissionScopes = permissions[0].value;
123
+ servicePrincipal.appRoles = permissions[1].value;
124
+ break;
125
+ }
126
+ return servicePrincipal;
127
+ });
128
+ }
129
+ getServicePrincipalPermissions(servicePrincipal, logger) {
130
+ return __awaiter(this, void 0, void 0, function* () {
131
+ if (this.verbose) {
132
+ logger.logToStderr(`Resolving permissions for the service principal...`);
133
+ }
134
+ const apiPermissions = [];
135
+ // hash table for resolving resource IDs to names
136
+ const resourceLookup = {};
137
+ // list of service principals for which to load permissions
138
+ const servicePrincipalsToResolve = [];
139
+ const appRoleAssignments = servicePrincipal.appRoleAssignments;
140
+ apiPermissions.push(...appRoleAssignments.map(appRoleAssignment => {
141
+ // store resource name for resolving OAuth2 grants
142
+ resourceLookup[appRoleAssignment.resourceId] = appRoleAssignment.resourceDisplayName;
143
+ // add to the list of service principals to load to get the app role
144
+ // display name
145
+ if (!servicePrincipalsToResolve.find(r => r.id === appRoleAssignment.resourceId)) {
146
+ servicePrincipalsToResolve.push({ id: appRoleAssignment.resourceId });
147
+ }
148
+ return {
149
+ resource: appRoleAssignment.resourceDisplayName,
150
+ // we store the app role ID temporarily and will later resolve to display name
151
+ permission: appRoleAssignment.appRoleId,
152
+ type: 'Application'
153
+ };
154
+ }));
155
+ const oauth2Grants = servicePrincipal.oauth2PermissionGrants;
156
+ oauth2Grants.forEach(oauth2Grant => {
157
+ var _a;
158
+ // see if we can resolve the resource name from the resources
159
+ // retrieved from app role assignments
160
+ const resource = (_a = resourceLookup[oauth2Grant.resourceId]) !== null && _a !== void 0 ? _a : oauth2Grant.resourceId;
161
+ if (resource === oauth2Grant.resourceId &&
162
+ !servicePrincipalsToResolve.find(r => r.id === oauth2Grant.resourceId)) {
163
+ // resource name not found in the resources
164
+ // add it to the list of resources to resolve
165
+ servicePrincipalsToResolve.push({ id: oauth2Grant.resourceId });
166
+ }
167
+ const scopes = oauth2Grant.scope.split(' ');
168
+ scopes.forEach(scope => {
169
+ apiPermissions.push({
170
+ resource,
171
+ permission: scope,
172
+ type: 'Delegated'
173
+ });
174
+ });
175
+ });
176
+ if (servicePrincipalsToResolve.length > 0) {
177
+ const servicePrincipals = yield Promise
178
+ .all(servicePrincipalsToResolve
179
+ .map(servicePrincipalInfo => this.getServicePrincipal(servicePrincipalInfo, logger, GetServicePrincipal.withPermissionDefinitions)));
180
+ servicePrincipals.forEach(servicePrincipal => {
181
+ apiPermissions.forEach(apiPermission => {
182
+ var _a, _b;
183
+ if (apiPermission.resource === servicePrincipal.id) {
184
+ apiPermission.resource = servicePrincipal.displayName;
185
+ }
186
+ if (apiPermission.resource === servicePrincipal.displayName &&
187
+ apiPermission.type === 'Application') {
188
+ apiPermission.permission = (_b = (_a = servicePrincipal.appRoles
189
+ .find(appRole => appRole.id === apiPermission.permission)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : apiPermission.permission;
190
+ }
191
+ });
192
+ });
193
+ }
194
+ return apiPermissions;
195
+ });
196
+ }
197
+ getAppRegistration(appId, logger) {
198
+ return __awaiter(this, void 0, void 0, function* () {
199
+ if (this.verbose) {
200
+ logger.logToStderr(`Retrieving Azure AD application registration ${appId}`);
201
+ }
202
+ const options = {
203
+ appId: appId,
204
+ output: 'json',
205
+ debug: this.debug,
206
+ verbose: this.verbose
207
+ };
208
+ const output = yield cli_1.Cli.executeCommandWithOutput(appGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
209
+ if (this.debug) {
210
+ logger.logToStderr(output.stderr);
211
+ }
212
+ return JSON.parse(output.stdout);
213
+ });
214
+ }
215
+ getAppRegPermissions(appId, logger) {
216
+ return __awaiter(this, void 0, void 0, function* () {
217
+ const application = yield this.getAppRegistration(appId, logger);
218
+ if (application.requiredResourceAccess.length === 0) {
219
+ return [];
220
+ }
221
+ const servicePrincipalsToResolve = application.requiredResourceAccess
222
+ .map(resourceAccess => {
223
+ return {
224
+ appId: resourceAccess.resourceAppId
225
+ };
226
+ });
227
+ const servicePrincipals = yield Promise
228
+ .all(servicePrincipalsToResolve.map(servicePrincipalInfo => this.getServicePrincipal(servicePrincipalInfo, logger, GetServicePrincipal.withPermissionDefinitions)));
229
+ const apiPermissions = [];
230
+ application.requiredResourceAccess.forEach(requiredResourceAccess => {
231
+ var _a;
232
+ const servicePrincipal = servicePrincipals
233
+ .find(servicePrincipal => (servicePrincipal === null || servicePrincipal === void 0 ? void 0 : servicePrincipal.appId) === requiredResourceAccess.resourceAppId);
234
+ const resourceName = (_a = servicePrincipal === null || servicePrincipal === void 0 ? void 0 : servicePrincipal.displayName) !== null && _a !== void 0 ? _a : requiredResourceAccess.resourceAppId;
235
+ requiredResourceAccess.resourceAccess.forEach(permission => {
236
+ apiPermissions.push({
237
+ resource: resourceName,
238
+ permission: this.getPermissionName(permission.id, permission.type, servicePrincipal),
239
+ type: permission.type === 'Role' ? 'Application' : 'Delegated'
240
+ });
241
+ });
242
+ });
243
+ return apiPermissions;
244
+ });
245
+ }
246
+ getPermissionName(permissionId, permissionType, servicePrincipal) {
247
+ var _a, _b, _c, _d;
248
+ if (!servicePrincipal) {
249
+ return permissionId;
250
+ }
251
+ switch (permissionType) {
252
+ case 'Role':
253
+ return (_b = (_a = servicePrincipal.appRoles
254
+ .find(appRole => appRole.id === permissionId)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : permissionId;
255
+ case 'Scope':
256
+ return (_d = (_c = servicePrincipal.oauth2PermissionScopes
257
+ .find(permissionScope => permissionScope.id === permissionId)) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : permissionId;
258
+ }
259
+ /* c8 ignore next 4 */
260
+ // permissionType is either 'Scope' or 'Role' but we need a safe default
261
+ // to avoid building errors. This code will never be reached.
262
+ return permissionId;
263
+ }
264
+ }
265
+ module.exports = new AppPermissionListCommand();
266
+ //# sourceMappingURL=permission-list.js.map
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const prefix = 'app';
4
+ exports.default = {
5
+ PERMISSION_LIST: `${prefix} permission list`
6
+ };
7
+ //# sourceMappingURL=commands.js.map