@pnp/cli-microsoft365 10.5.0 → 10.6.0-beta.195c8d5

package/dist/m365/util/commands/accesstoken/accesstoken-get.js

@@ -7,6 +7,7 @@ var _UtilAccessTokenGetCommand_instances, _UtilAccessTokenGetCommand_initTelemet
 import auth, { Auth } from '../../../../Auth.js';
 import Command from '../../../../Command.js';
 import commands from '../../commands.js';
+import { accessToken } from '../../../../utils/accessToken.js';
 class UtilAccessTokenGetCommand extends Command {
     get name() {
         return commands.ACCESSTOKEN_GET;
@@ -34,8 +35,14 @@ class UtilAccessTokenGetCommand extends Command {
             resource = Auth.getEndpointForResource('https://graph.microsoft.com', auth.connection.cloudType);
         }
         try {
-            const accessToken = await auth.ensureAccessToken(resource, logger, this.debug, args.options.new);
-            await logger.log(accessToken);
+            const token = await auth.ensureAccessToken(resource, logger, this.debug, args.options.new);
+            if (args.options.decoded) {
+                const { header, payload } = accessToken.getDecodedAccessToken(token);
+                await logger.logRaw(`${JSON.stringify(header, null, 2)}.${JSON.stringify(payload, null, 2)}.[signature]`);
+            }
+            else {
+                await logger.log(token);
+            }
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
@@ -45,7 +52,8 @@ class UtilAccessTokenGetCommand extends Command {
 _UtilAccessTokenGetCommand_instances = new WeakSet(), _UtilAccessTokenGetCommand_initTelemetry = function _UtilAccessTokenGetCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            new: args.options.new
+            new: args.options.new,
+            decoded: args.options.decoded
         });
     });
 }, _UtilAccessTokenGetCommand_initOptions = function _UtilAccessTokenGetCommand_initOptions() {
@@ -53,6 +61,8 @@ _UtilAccessTokenGetCommand_instances = new WeakSet(), _UtilAccessTokenGetCommand
         option: '-r, --resource <resource>'
     }, {
         option: '--new'
+    }, {
+        option: '--decoded'
     });
 };
 export default new UtilAccessTokenGetCommand();

package/dist/utils/accessToken.js

@@ -75,6 +75,14 @@ export const accessToken = {
         }
         return userId;
     },
+    getDecodedAccessToken(accessToken) {
+        const chunks = accessToken.split('.');
+        const headerString = Buffer.from(chunks[0], 'base64').toString();
+        const payloadString = Buffer.from(chunks[1], 'base64').toString();
+        const header = JSON.parse(headerString);
+        const payload = JSON.parse(payloadString);
+        return { header, payload };
+    },
     /**
      * Asserts the presence of a delegated access token.
      * @throws {CommandError} Will throw an error if the access token is not available.

package/dist/utils/entraApp.js

@@ -3,6 +3,7 @@ import request from '../request.js';
 import { odata } from './odata.js';
 import { formatting } from './formatting.js';
 import { cli } from '../cli/cli.js';
+import { optionsUtils } from './optionsUtils.js';
 async function getCertificateBase64Encoded({ options, logger, debug }) {
     if (options.certificateBase64Encoded) {
         return options.certificateBase64Encoded;
@@ -129,7 +130,7 @@ function updateAppPermissions({ spId, resourceAccessPermission, oAuth2Permission
 }
 export const entraApp = {
     appPermissions: [],
-    createAppRegistration: async ({ options, apis, logger, verbose, debug }) => {
+    createAppRegistration: async ({ options, apis, logger, verbose, debug, unknownOptions }) => {
         const applicationInfo = {
             displayName: options.name,
             signInAudience: options.multitenant ? 'AzureADMultipleOrgs' : 'AzureADMyOrg'
@@ -164,6 +165,7 @@ export const entraApp = {
         if (options.allowPublicClientFlows) {
             applicationInfo.isFallbackPublicClient = true;
         }
+        optionsUtils.addUnknownOptionsToPayload(applicationInfo, unknownOptions);
         if (verbose) {
             await logger.logToStderr(`Creating Microsoft Entra app registration...`);
         }

package/dist/utils/optionsUtils.js

@@ -0,0 +1,28 @@
+const longOptionRegex = /--([^\s]+)/;
+const shortOptionRegex = /-([a-z])\b/;
+export const optionsUtils = {
+    getUnknownOptions(options, knownOptions) {
+        const unknownOptions = JSON.parse(JSON.stringify(options));
+        // remove minimist catch-all option
+        delete unknownOptions._;
+        knownOptions.forEach(o => {
+            const longOptionName = longOptionRegex.exec(o.option)[1];
+            delete unknownOptions[longOptionName];
+            // short names are optional so we need to check if the current command has
+            // one before continuing
+            const shortOptionMatch = shortOptionRegex.exec(o.option);
+            if (shortOptionMatch) {
+                const shortOptionName = shortOptionMatch[1];
+                delete unknownOptions[shortOptionName];
+            }
+        });
+        return unknownOptions;
+    },
+    addUnknownOptionsToPayload(payload, unknownOptions) {
+        const unknownOptionsNames = Object.getOwnPropertyNames(unknownOptions);
+        unknownOptionsNames.forEach(o => {
+            payload[o] = unknownOptions[o];
+        });
+    }
+};
+//# sourceMappingURL=optionsUtils.js.map

package/dist/utils/powerPlatform.js

@@ -51,7 +51,7 @@ export const powerPlatform = {
         }
         if (items.length > 1) {
             const resultAsKeyValuePair = formatting.convertArrayToHashTable('websiteUrl', items);
-            return cli.handleMultipleResultsFound(`Multiple Power Page websites with name '${websiteName}' found`, resultAsKeyValuePair);
+            return cli.handleMultipleResultsFound(`Multiple Power Page websites with name '${websiteName}' found.`, resultAsKeyValuePair);
         }
         return items[0];
     },
@@ -62,6 +62,56 @@ export const powerPlatform = {
             throw Error(`The specified Power Page website with url '${url}' does not exist.`);
         }
         return items[0];
+    },
+    /**
+     * Get a card by name
+     * Returns a card object
+     * @param dynamicsApiUrl The dynamics api url of the environment
+     * @param name The name of the card
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     */
+    async getCardByName(dynamicsApiUrl, name) {
+        const requestOptions = {
+            url: `${dynamicsApiUrl}/api/data/v9.1/cards?$filter=name eq '${name}'`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const result = await request.get(requestOptions);
+        if (result.value.length === 0) {
+            throw Error(`The specified card '${name}' does not exist.`);
+        }
+        if (result.value.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('cardid', result.value);
+            return cli.handleMultipleResultsFound(`Multiple cards with name '${name}' found.`, resultAsKeyValuePair);
+        }
+        return result.value[0];
+    },
+    /**
+   * Get a solution by name
+   * Returns the solution object
+   * @param dynamicsApiUrl The dynamics api url of the environment
+   * @param name The name of the solution
+   */
+    async getSolutionByName(dynamicsApiUrl, name) {
+        const requestOptions = {
+            url: `${dynamicsApiUrl}/api/data/v9.0/solutions?$filter=isvisible eq true and uniquename eq \'${name}\'&$expand=publisherid($select=friendlyname)&$select=solutionid,uniquename,version,publisherid,installedon,solutionpackageversion,friendlyname,versionnumber&api-version=9.1`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const result = await request.get(requestOptions);
+        if (result.value.length === 0) {
+            throw Error(`The specified solution '${name}' does not exist.`);
+        }
+        if (result.value.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('solutionid', result.value);
+            return cli.handleMultipleResultsFound(`Multiple solutions with name '${name}' found.`, resultAsKeyValuePair);
+        }
+        return result.value[0];
     }
 };
 //# sourceMappingURL=powerPlatform.js.map

package/dist/utils/prompt.js

@@ -6,13 +6,20 @@ let inquirerSelect;
 ;
 ;
 export const prompt = {
-    /* c8 ignore next 9 */
+    /* c8 ignore next 16 */
     async forInput(config) {
         if (!inquirerInput) {
             inquirerInput = await import('@inquirer/input');
         }
         const errorOutput = cli.getSettingWithDefaultValue(settingsNames.errorOutput, 'stderr');
-        return inquirerInput.default(config, { output: errorOutput === 'stderr' ? process.stderr : process.stdout });
+        return inquirerInput
+            .default(config, { output: errorOutput === 'stderr' ? process.stderr : process.stdout })
+            .catch(error => {
+            if (error instanceof Error && error.name === 'ExitPromptError') {
+                return ''; // noop; handle Ctrl + C
+            }
+            throw error;
+        });
     },
     /* c8 ignore next 9 */
     async forConfirmation(config) {

package/dist/utils/spo.js

@@ -519,10 +519,11 @@ export const spo = {
     },
     /**
    * Retrieves the spo user by email.
+   * Returns a user object
    * @param webUrl Web url
    * @param email The email of the user
    * @param logger the Logger object
-   * @param verbose set for verbose logging
+   * @param verbose Set for verbose logging
    */
     async getUserByEmail(webUrl, email, logger, verbose) {
         if (verbose && logger) {
@@ -593,10 +594,11 @@ export const spo = {
     },
     /**
     * Retrieves the spo group by name.
+    * Returns a group object
     * @param webUrl Web url
     * @param name The name of the group
     * @param logger the Logger object
-    * @param verbose set for verbose logging
+    * @param verbose Set for verbose logging
     */
     async getGroupByName(webUrl, name, logger, verbose) {
         if (verbose && logger) {
@@ -615,10 +617,13 @@ export const spo = {
     },
     /**
     * Retrieves the role definition by name.
+    * Returns a RoleDefinition object
+    * Returns a RoleDefinition object
     * @param webUrl Web url
     * @param name the name of the role definition
     * @param logger the Logger object
-    * @param verbose set for verbose logging
+    * @param verbose Set for verbose logging
+    * @param verbose Set for verbose logging
     */
     async getRoleDefinitionByName(webUrl, name, logger, verbose) {
         if (verbose && logger) {
@@ -1753,6 +1758,30 @@ export const spo = {
             responseType: 'json'
         };
         return request.post(requestOptions);
+    },
+    /**
+    * Get a role definition by name
+    * Returns a RoleDefinition object
+    * @param webUrl The web url
+    * @param name  the name of the role definition
+    * @param logger The logger object
+    * @param verbose Set for verbose logging
+    */
+    async getRoleDefintionByName(webUrl, name, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Retrieving the role definition by name ${name}`);
+        }
+        const response = await odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
+        const roleDefinition = response.find((role) => role.Name === name);
+        if (!roleDefinition) {
+            throw new Error(`The specified role definition name '${name}' does not exist.`);
+        }
+        const permissions = new BasePermissions();
+        permissions.high = roleDefinition.BasePermissions.High;
+        permissions.low = roleDefinition.BasePermissions.Low;
+        roleDefinition.BasePermissionsValue = permissions.parse();
+        roleDefinition.RoleTypeKindValue = RoleType[roleDefinition.RoleTypeKind];
+        return roleDefinition;
     }
 };
 //# sourceMappingURL=spo.js.map

package/docs/docs/cmd/entra/policy/policy-list.mdx

@@ -16,7 +16,7 @@ m365 entra policy list [options]
 
 ```md definition-list
 `-t, --type [type]`
-: The type of policies to return. Allowed values `activityBasedTimeout`, `authorization`, `claimsMapping`, `homeRealmDiscovery`, `identitySecurityDefaultsEnforcement`, `tokenIssuance`, `tokenLifetime`. If omitted, all policies are returned.
+: The type of policies to return. Allowed values `activityBasedTimeout`, `adminConsentRequest`, `appManagement`, `authenticationFlows`, `authenticationMethods`, `authenticationStrength`, `authorization`, `claimsMapping`, `conditionalAccess`, `crossTenantAccess`, `defaultAppManagement`, `deviceRegistration`, `featureRolloutPolicy`, `homeRealmDiscovery`, `identitySecurityDefaultsEnforcement`, `permissionGrant`, `roleManagement`, `tokenIssuance`, `tokenLifetime`. If omitted, all policies are returned.
 ```
 
 <Global />

package/docs/docs/cmd/graph/directoryextension/directoryextension-get.mdx

@@ -38,16 +38,15 @@ m365 graph directoryextension get [options]
 Get directory extension by id registered for an application specified by app id.
 
 ```sh
-m365 directoryextension get --id 1f0f15e3-925d-40f0-8fc8-9d3ad135bce0 --appId fd918e4b-c821-4efb-b50a-5eddd23afc6f
+m365 graph directoryextension get --id 1f0f15e3-925d-40f0-8fc8-9d3ad135bce0 --appId fd918e4b-c821-4efb-b50a-5eddd23afc6f
 ```
 
 Get directory extension by name registered for an application specified by name.
 
 ```sh
-m365 directoryextension get --name extension_105be60b603845fea385e58772d9d630_GitHubWorkAccount --appName ContosoApp
+m365 graph directoryextension get --name extension_105be60b603845fea385e58772d9d630_GitHubWorkAccount --appName ContosoApp
 ```
 
-
 ## Response
 
 <Tabs>

package/docs/docs/cmd/graph/openextension/openextension-add.mdx

@@ -0,0 +1,120 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph openextension add
+
+Adds an open extension to a resource
+
+## Usage
+
+```sh
+m365 graph openextension add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: The name of the open extension.
+
+`-i, --resourceId <resourceId>`
+: The Id of the resource for which the extension is created.
+
+`-t, --resourceType <resourceType>`
+: The resource type for which the extension is created. Allowed values are `user`, `group`, `device`, `organization`.
+```
+
+<Global />
+
+## Remarks
+
+This command allows using unknown options to add custom data to the open extension.
+
+When adding an open extension to a user, it's possible to use the UPN as the resourceId.
+
+:::warning[Escaping JSON in PowerShell]
+
+When creating open extensions it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Create a new open extension for a user specified by id. Extension properties are specified by unknown options.
+
+```sh
+m365 graph openextension add --resourceId eb77fbcf-6fe8-458b-985d-1747284793bc --resourceType user --name 'com.contoso.roamingSettings' --theme dark --color red --language English
+```
+
+Create a new open extension for a user specified by userName. Extension properties are specified by unknown options.
+
+```sh
+m365 graph openextension add --resourceId adelev@contoso.com --resourceType user --name 'com.contoso.roamingSettings' --theme dark --color red --language English
+```
+
+Create a new open extension for a group, one of the property represents a JSON object
+
+```sh
+m365 graph openextension add --resourceId eb77fbcf-6fe8-458b-985d-1747284793bc --resourceType group --name 'com.contoso.roamingSettings' --settings '{"theme": "dark", "color": "red", "language": "English"}' --supportedSystem 'Linux'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "extensionName": "com.contoso.roamingSettings",
+    "settings": {
+      "theme": "dark",
+      "color": "red",
+      "language": "English"
+    },
+    "supportedSystem": "Linux",
+    "id": "com.contoso.roamingSettings"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  extensionName  : com.contoso.roamingSettings
+  id             : com.contoso.roamingSettings
+  settings       : {"theme":"dark","color":"red","language":"English"}
+  supportedSystem: Linux
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  extensionName,supportedSystem,id
+  com.contoso.roamingSettings,Linux,com.contoso.roamingSettings
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph openextension add --name "com.contoso.roamingSettings" --resourceId "01b62bc5-9701-4f93-9587-9d1ea58a086d" --resourceType "user" --settings "{"theme": "dark", "color": "red", "language": "English"}" --supportedSystem "Linux"
+
+  Date: 3/13/2025
+
+  ## com.contoso.roamingSettings
+
+  Property | Value
+  ---------|-------
+  extensionName | com.contoso.roamingSettings
+  supportedSystem | Linux
+  id | com.contoso.roamingSettings
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Open extensions: https://learn.microsoft.com/graph/api/opentypeextension-post-opentypeextension

package/docs/docs/cmd/graph/openextension/openextension-get.mdx

@@ -0,0 +1,111 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph openextension get
+
+Retrieves a specific open extension for a resource
+
+## Usage
+
+```sh
+m365 graph openextension get [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: The name of the open extension to retrieve.
+
+`-i, --resourceId <resourceId>`
+: The Id of the resource for which to retrieve the open extension.
+
+`-t, --resourceType <resourceType>`
+: The type of resource. Allowed values are `user`, `group`, `device`, `organization`.
+```
+
+<Global />
+
+## Examples
+
+Retrieve a specified open extension for a user specified by id.
+
+```sh
+m365 graph openextension get --resourceId eb77fbcf-6fe8-458b-985d-1747284793bc --name 'com.contoso.roamingSettings' --resourceType user
+```
+
+Retrieve a specified open extension for a user specified by UPN.
+
+```sh
+m365 graph openextension get --resourceId john.doe@contoso.com --name 'com.contoso.roamingSettings' --resourceType user
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "extensionName": "com.contoso.roamingSettings",
+    "name": "com.contoso.roamingSettings",
+    "resourceId": "john.doe@contoso.com",
+    "resourceType": "user",
+    "theme": "dark",
+    "color": "red",
+    "language": "English",
+    "id": "com.contoso.roamingSettings"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  color        : red
+  extensionName: com.contoso.roamingSettings
+  id           : com.contoso.roamingSettings
+  language     : English
+  name         : com.contoso.roamingSettings
+  resourceId   : john.doe@contoso.com
+  resourceType : user
+  theme        : dark
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  extensionName,name,resourceId,resourceType,theme,color,language,id
+  com.contoso.roamingSettings,com.contoso.roamingSettings,john.doe@contoso.com,user,dark,red,English,com.contoso.roamingSettings
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph openextension get --debug "false" --verbose "false" --resourceId "john.doe@contoso.com" --resourceType "user" --name "com.contoso.roamingSettings"
+
+  Date: 2025-04-07
+
+  ## com.contoso.roamingSettings (com.contoso.roamingSettings)
+
+  Property | Value
+  ---------|-------
+  extensionName | com.contoso.roamingSettings
+  name | com.contoso.roamingSettings
+  resourceId | john.doe@contoso.com
+  resourceType | user
+  theme | dark
+  color | red
+  language | English
+  id | com.contoso.roamingSettings
+  ```
+  
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Open extensions: https://learn.microsoft.com/graph/extensibility-overview?tabs=http#open-extensions

package/docs/docs/cmd/graph/openextension/openextension-list.mdx

@@ -0,0 +1,129 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# graph openextension list
+
+Retrieves all open extensions for a resource
+
+## Usage
+
+```sh
+m365 graph openextension list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --resourceId <resourceId>`
+: The Id of the resource for which to retrieve open extensions.
+
+`-t, --resourceType <resourceType>`
+: The type of resource. Allowed values are `user`, `group`, `device`, `organization`.
+```
+
+<Global />
+
+## Examples
+
+Retrieve open extensions for a user specified by id
+
+```sh
+m365 graph openextension list --resourceId eb77fbcf-6fe8-458b-985d-1747284793bc --resourceType user
+```
+
+Retrieve open extensions for a user specified by UPN
+
+```sh
+m365 graph openextension list --resourceId john.doe@contoso.com --resourceType user
+```
+
+Retrieve open extensions for a group specified by id
+
+```sh
+m365 graph openextension list --resourceId 19588303-70bf-44a4-beb1-e2f0f1ed06b3 --resourceType group
+```
+
+Retrieve open extensions for an organization specified by id
+
+```sh
+m365 graph openextension list --resourceId c956e711-f074-40c3-8431-fbd69bb67d9c --resourceType organization
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "extensionName": "com.contoso.roamingSettings",
+      "theme": "dark",
+      "color": "purple",
+      "lang": "Japanese",
+      "id": "com.contoso.roamingSettings"
+    },
+    {
+      "extensionName": "com.test.m365",
+      "settings": {
+        "theme": "dark"
+      },
+      "supportedSystem": "Linux",
+      "id": "com.test.m365"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  extensionName                id
+  ---------------------------  ---------------------------
+  com.contoso.roamingSettings  com.contoso.roamingSettings
+  com.test.m365                com.test.m365
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  extensionName,theme,color,lang,id
+  com.contoso.roamingSettings,dark,purple,Japanese,com.contoso.roamingSettings
+  com.test.m365,,,,com.test.m365
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # graph openextension list --resourceId "eb77fbcf-6fe8-458b-985d-1747284793bc" --resourceType "user"
+
+  Date: 3/29/2025
+
+  ## com.contoso.roamingSettings
+
+  Property | Value
+  ---------|-------
+  extensionName | com.contoso.roamingSettings
+  theme | dark
+  color | purple
+  lang | Japanese
+  id | com.contoso.roamingSettings
+
+  ## com.test.m365
+
+  Property | Value
+  ---------|-------
+  extensionName | com.test.m365
+  supportedSystem | Linux
+  id | com.test.m365
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Open extensions: https://learn.microsoft.com/graph/extensibility-overview?tabs=http#open-extensions