@pnp/cli-microsoft365 6.3.0-beta.c3dc921 → 6.3.0-beta.e40d7b4

package/dist/utils/spo.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.spo = void 0;
 const url = require("url");
@@ -9,6 +18,7 @@ const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
 const formatting_1 = require("./formatting");
+const odata_1 = require("./odata");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -237,6 +247,24 @@ exports.spo = {
             });
         });
     },
+    /**
+     * Returns the Graph id of a site
+     * @param webUrl web url e.g. https://contoso.sharepoint.com/sites/site1
+     */
+    getSpoGraphSiteId(webUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = new URL(webUrl);
+            const requestOptions = {
+                url: `https://graph.microsoft.com/v1.0/sites/${url.hostname}:${url.pathname}?$select=id`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const result = yield request_1.default.get(requestOptions);
+            return result.id;
+        });
+    },
     /**
      * Ensures the folder path exists
      * @param webFullUrl web full url e.g. https://contoso.sharepoint.com/sites/site1
@@ -429,6 +457,94 @@ exports.spo = {
                 reject('Cannot proceed. Folder _ObjectIdentity_ not found'); // this is not suppose to happen
             }, (err) => { reject(err); });
         });
+    },
+    /**
+     * Retrieves the SiteId, VroomItemId and VroomDriveId from a specific file.
+     * @param webUrl Web url
+     * @param fileId GUID ID of the file
+     * @param fileUrl Decoded URL of the file
+     */
+    getVroomFileDetails(webUrl, fileId, fileUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let requestUrl = `${webUrl}/_api/web/`;
+            if (fileUrl) {
+                const fileServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webUrl, fileUrl);
+                requestUrl += `GetFileByServerRelativePath(decodedUrl='${formatting_1.formatting.encodeQueryParameter(fileServerRelativeUrl)}')`;
+            }
+            else {
+                requestUrl += `GetFileById('${fileId}')`;
+            }
+            requestUrl += '?$select=SiteId,VroomItemId,VroomDriveId';
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const res = yield request_1.default.get(requestOptions);
+            return res;
+        });
+    },
+    /**
+     * Retrieves a list of Custom Actions from a SharePoint site.
+     * @param webUrl Web url
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     * @param filter An OData filter query to limit the results.
+     */
+    getCustomActions(webUrl, scope, filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            const queryString = filter ? `?$filter=${filter}` : "";
+            if (scope && scope !== "All") {
+                return yield odata_1.odata.getAllItems(`${webUrl}/_api/${scope}/UserCustomActions${queryString}`);
+            }
+            const customActions = [
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Site/UserCustomActions${queryString}`),
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Web/UserCustomActions${queryString}`)
+            ];
+            return customActions;
+        });
+    },
+    /**
+     * Retrieves a Custom Actions from a SharePoint site by Id.
+     * @param webUrl Web url
+     * @param id The Id of the Custom Action
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     */
+    getCustomActionById(webUrl, id, scope) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            function getById(webUrl, id, scope) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const requestOptions = {
+                        url: `${webUrl}/_api/${scope}/UserCustomActions(guid'${id}')`,
+                        headers: {
+                            accept: 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    const result = yield request_1.default.get(requestOptions);
+                    if (result["odata.null"] === true) {
+                        return undefined;
+                    }
+                    return result;
+                });
+            }
+            if (scope && scope !== "All") {
+                return yield getById(webUrl, id, scope);
+            }
+            const customActionOnWeb = yield getById(webUrl, id, "Web");
+            if (customActionOnWeb) {
+                return customActionOnWeb;
+            }
+            const customActionOnSite = yield getById(webUrl, id, "Site");
+            return customActionOnSite;
+        });
     }
 };
 //# sourceMappingURL=spo.js.map

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

@@ -23,6 +23,7 @@ m365 aad app list
 ## Response
 
 === "JSON"
+
     ```json
     [
       {
@@ -136,6 +137,7 @@ m365 aad app list
     ```
 
 === "Text"
+
     ```text
     appId                                 id                                    displayName                                                              signInAudience
     ------------------------------------  ------------------------------------  -----------------------------------------------------------------------  ----------------------------------
@@ -143,6 +145,7 @@ m365 aad app list
     ```
 
 === "CSV"
+
     ```csv
     appId,id,displayName,signInAudience
     61ed4fab-a861-4307-bb87-a6a53dbe39f5,ff2798f7-1c7a-4607-8a7b-3d5e0c18c756,TestAppPermissions,AzureADMyOrg

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

@@ -0,0 +1,168 @@
+# aad user add
+
+Creates a new user
+
+## Usage
+
+```sh
+m365 aad user add [options]
+```
+
+## Options
+
+`--displayName <displayName>`
+: The name to display in the address book for the user.
+
+`--userName <userName>`
+: The user principal name (someuser@contoso.com).
+
+`--accountEnabled [accountEnabled]`
+: Whether the account is enabled. Possible values: `true`, `false`. Default value is `true`.
+
+`--mailNickname [mailNickname]`
+: The mail alias for the user. By default this value will be extracted from `userName`.
+
+`--password [password]`
+: The password for the user. When not specified, a password will be generated.
+
+`--firstName [firstName]`
+: The given name (first name) of the user. Maximum length is 64 characters.
+
+`--lastName [lastName]`
+: The user's surname (family name or last name). Maximum length is 64 characters.
+
+`--forceChangePasswordNextSignIn`
+: Whether the user should change his/her password on the next login.
+
+`--forceChangePasswordNextSignInWithMfa`
+: Whether the user should change his/her password on the next login and setup MFA.
+
+`--usageLocation [usageLocation]`
+: A two letter [country code](https://learn.microsoft.com/en-us/partner-center/commercial-marketplace-co-sell-location-codes#country-and-region-codes) (ISO standard 3166). Required for users that will be assigned licenses.
+
+`--officeLocation [officeLocation]` 
+: The office location in the user's place of business.
+
+`--jobTitle [jobTitle]`
+: The user's job title. Maximum length is 128 characters.
+
+`--companyName [companyName]`
+: The company name which the user is associated. The maximum length is 64 characters.
+
+`--department [department]`
+: The name for the department in which the user works. Maximum length is 64 characters.
+
+`--preferredLanguage [preferredLanguage]`
+: The preferred language for the user. Should follow [ISO 639-1 Code](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a). Example: `en-US`.
+
+`--managerUserId [managerUserId]`
+: User ID of the user's manager. Specify `managerUserId` or `managerUserName` but not both.
+
+`--managerUserName [managerUserName]`
+: User principal name of the manager. Specify `managerUserId` or `managerUserName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+
+!!! note
+    After running this command, it may take a minute before the user is effectively created in the tenant.
+
+## Examples
+
+Create a user and let him/her update the password at first login
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --forceChangePasswordNextSignIn
+```
+
+Create a user with job information
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName John --lastName Doe --jobTitle "Sales Manager" --companyName Contoso --department Sales --officeLocation Vosselaar --forceChangePasswordNextSignIn
+```
+
+Create a user with language information
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --preferredLanguage "nl-BE" --usageLocation BE --forceChangePasswordNextSignIn
+```
+
+Create a user with a manager
+
+```sh
+m365 aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --managerUserName "adele@contoso.com"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "990e2425-f595-43bc-85ed-b89a44093793",
+      "businessPhones": [],
+      "displayName": "John Doe",
+      "givenName": "John",
+      "jobTitle": "Sales Manager",
+      "mail": null,
+      "mobilePhone": null,
+      "officeLocation": "Vosselaar",
+      "preferredLanguage": "nl-BE",
+      "surname": "Doe",
+      "userPrincipalName": "john.doe@contoso.com",
+      "password": "SomePassw0rd"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    businessPhones   : []
+    displayName      : John Doe
+    givenName        : John
+    id               : 990e2425-f595-43bc-85ed-b89a44093793
+    jobTitle         : Sales Manager
+    mail             : null
+    mobilePhone      : null
+    officeLocation   : Vosselaar
+    password         : SomePassw0rd
+    preferredLanguage: nl-BE
+    surname          : Doe
+    userPrincipalName: john.doe@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,password
+    990e2425-f595-43bc-85ed-b89a44093793,[],John Doe,John,Sales Manager,,,Vosselaar,nl-BE,Doe,john.doe@contoso.com,SomePassw0rd
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user add --displayName "John Doe" --userName "john.doe@contoso.com" --password "SomePassw0rd" --firstName "John" --lastName "Doe" --jobTitle "Sales Manager" --officeLocation "Vosselaar" --preferredLanguage "nl-BE"
+
+    Date: 16/02/2023
+
+    ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
+
+    Property | Value
+    ---------|-------
+    id | 990e2425-f595-43bc-85ed-b89a44093793
+    businessPhones | []
+    displayName | John Doe
+    givenName | John
+    jobTitle | Sales Manager
+    mail | null
+    mobilePhone | null
+    officeLocation | Vosselaar
+    preferredLanguage | nl-BE
+    surname | Doe
+    userPrincipalName | john.doe@contoso.com
+    password | SomePassw0rd
+    ```

package/docs/docs/cmd/aad/user/user-license-list.md

@@ -0,0 +1,98 @@
+# aad user license list
+
+Lists the license details for a given user
+
+## Usage
+
+```sh
+m365 aad user license list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! tip
+    If you don't specify any option, the command will list the license details of the current logged in user. This does not work when using application permissions.
+
+## Examples
+
+List license details of the current logged in user.
+
+```sh
+m365 aad user license list
+```
+
+List license details of a specific user by its UPN.
+
+```sh
+m365 aad user license list --userName john.doe@contoso.com
+```
+
+List license details of a specific user by its ID.
+
+```sh
+m365 aad user license list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw",
+        "skuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",
+        "skuPartNumber": "DEVELOPERPACK_E5",
+        "servicePlans": [
+          {
+            "servicePlanId": "7547a3fe-08ee-4ccb-b430-5077c5041653",
+            "servicePlanName": "YAMMER_ENTERPRISE",
+            "provisioningStatus": "Success",
+            "appliesTo": "User"
+          }
+        ]
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id           : x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId        : c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber: DEVELOPERPACK_E5
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,skuId,skuPartNumber
+    x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw,c42b9cae-ea4f-4ab7-9717-81576235ccac,DEVELOPERPACK_E5
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user license list --userId "0c9c625f-faa9-4c3b-8cd8-d874b869f78c"
+
+    Date: 2/19/2023
+
+    ## x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+
+    Property | Value
+    ---------|-------
+    id | x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId | c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber | DEVELOPERPACK\_E5
+    servicePlans | [{"servicePlanId":"7547a3fe-08ee-4ccb-b430-5077c5041653","servicePlanName":"YAMMER\_ENTERPRISE","provisioningStatus":"Success","appliesTo":"User"}]
+    ```

package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md

@@ -0,0 +1,42 @@
+# aad user recyclebinitem clear
+
+Removes all users from the tenant recycle bin
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem clear [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before all deleted users are effectively removed from the tenant.
+
+## Examples
+
+Removes all users from the tenant recycle bin
+
+```sh
+m365 aad user recyclebinitem clear
+```
+
+Removes all users from the tenant recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem clear --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md

@@ -0,0 +1,82 @@
+# aad user recyclebinitem list
+
+Lists users from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all removed users
+
+```sh
+m365 aad user recyclebinitem list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "businessPhones": [],
+        "displayName": "John Doe",
+        "givenName": "John Doe",
+        "jobTitle": "Developer",
+        "mail": "john@contoso.com",
+        "mobilePhone": "0476345130",
+        "officeLocation": "Washington",
+        "preferredLanguage": "nl-BE",
+        "surname": "John",
+        "userPrincipalName": "7e06b56615f340138bf879874d52e68ajohn@contoso.com",
+        "id": "7e06b566-15f3-4013-8bf8-79874d52e68a"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName  userPrincipalName
+    ------------------------------------  -----------  -----------------------------------------------
+    7e06b566-15f3-4013-8bf8-79874d52e68a  John Doe     7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,userPrincipalName
+    7e06b566-15f3-4013-8bf8-79874d52e68a,John Doe,7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user recyclebinitem list
+
+    Date: 14/02/2023
+
+    ## John Doe (7e06b566-15f3-4013-8bf8-79874d52e68a)
+
+    Property | Value
+    ---------|-------
+    businessPhones | []
+    displayName | John Doe
+    givenName | John Doe
+    jobTitle | Developer
+    mail | john@contoso.com
+    mobilePhone | 0476345130
+    officeLocation | Washington
+    preferredLanguage | nl-BE
+    surname | John
+    userPrincipalName | 7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    id | 7e06b566-15f3-4013-8bf8-79874d52e68a
+    ```

package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md

@@ -0,0 +1,45 @@
+# aad user recyclebinitem remove
+
+Removes a user from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem remove [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the deleted user.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before the deleted user is effectively removed from the tenant.
+
+## Examples
+
+Removes a specific user from the recycle bin
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Removes a specific user from the recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,51 @@
+# aad user remove
+
+Removes a specific user
+
+## Usage
+
+```sh
+m365 aad user remove [options]
+```
+
+## Options
+
+`--id [id]`
+: The ID of the user. Specify either `id` or `userName` but not both.
+
+`--userName [userName]`
+:	User principal name of the user. Specify either `id` or `userName` but not both.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before the user is effectively moved to the recycle bin.
+
+## Examples
+
+Removes a specific user by id
+
+```sh
+m365 aad user remove --id a33bd401-9117-4e0e-bb7b-3f61c1539e10
+```
+
+Removes a specific user by its UPN
+
+```sh
+m365 aad user remove --name john.doe@contoso.com
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -74,7 +74,7 @@ m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabl
 Reset password of a given user by userPrincipalName and require the user to change the password on the next sign in
 
 ```sh
-m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --password 6NLUId79Lc24 --forceChangePasswordNextSignIn
+m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
 ```
 
 Change password of the currently logged in user
@@ -83,6 +83,6 @@ Change password of the currently logged in user
 m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --currentPassword SLBF5gnRtyYc --newPassword 6NLUId79Lc24
 ```
 
-### Response
+## Response
 
 The command won't return a response on success.