@pnp/cli-microsoft365 4.1.0-beta.4198b60 → 4.1.0-beta.6c0929c

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

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class AadUserSetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.USER_SET;
+    }
+    get description() {
+        return 'Updates information about the specified user';
+    }
+    allowUnknownOptions() {
+        return true;
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.objectId = typeof args.options.objectId !== 'undefined';
+        telemetryProps.userPrincipalName = typeof args.options.userPrincipalName !== 'undefined';
+        telemetryProps.accountEnabled = (!!args.options.accountEnabled).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const manifest = this.mapRequestBody(args.options);
+        const requestOptions = {
+            url: `${this.resource}/v1.0/users/${encodeURIComponent(args.options.objectId ? args.options.objectId : args.options.userPrincipalName)}`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json',
+            data: manifest
+        };
+        request_1.default
+            .patch(requestOptions)
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    mapRequestBody(options) {
+        const requestBody = {};
+        const excludeOptions = [
+            'debug',
+            'verbose',
+            'output',
+            'objectId',
+            'i',
+            'userPrincipalName',
+            'n',
+            'accountEnabled'
+        ];
+        if (options.accountEnabled) {
+            requestBody['AccountEnabled'] = String(options.accountEnabled) === "true";
+        }
+        Object.keys(options).forEach(key => {
+            if (excludeOptions.indexOf(key) === -1) {
+                requestBody[key] = `${options[key]}`;
+            }
+        });
+        return requestBody;
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --objectId [objectId]'
+            },
+            {
+                option: '-n, --userPrincipalName [userPrincipalName]'
+            },
+            {
+                option: '--accountEnabled [accountEnabled]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.objectId && !args.options.userPrincipalName) {
+            return 'Specify either objectId or userPrincipalName';
+        }
+        if (args.options.objectId && args.options.userPrincipalName) {
+            return 'Specify either objectId or userPrincipalName but not both';
+        }
+        if (args.options.objectId &&
+            !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadUserSetCommand();
+//# sourceMappingURL=user-set.js.map

package/dist/m365/aad/commands.js

@@ -47,6 +47,7 @@ exports.default = {
     SITECLASSIFICATION_SET: `${prefix} siteclassification set`,
     SP_GET: `${prefix} sp get`,
     USER_GET: `${prefix} user get`,
-    USER_LIST: `${prefix} user list`
+    USER_LIST: `${prefix} user list`,
+    USER_SET: `${prefix} user set`
 };
 //# sourceMappingURL=commands.js.map

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

@@ -0,0 +1,60 @@
+# aad user set
+
+Updates information of the specified user
+
+## Usage
+
+```sh
+m365 aad user set [options]
+```
+
+## Options
+
+`-i, --objectId [objectId]`
+: The object ID of the user to update. Specify `objectId` or `userPrincipalName` but not both
+
+`-n, --userPrincipalName [userPrincipalName]`
+: User principal name of the user to update. Specify `objectId` or `userPrincipalName` but not both
+
+`--accountEnabled [accountEnabled]`
+: Boolean value specifying whether the account is enabled. Valid values are `true,false`
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+You can update information of a user, either by specifying that user's id (`objectId`) or user name (`userPrincipalName`), but not both.
+
+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.
+
+## Examples
+
+Update specific property _department_ of user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --Department IT
+```
+
+Update multiple properties of user with name _steve@contoso.onmicrosoft.com_
+
+```sh
+m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --Department "Sales & Marketing" --CompanyName Contoso
+```
+
+Enable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
+```
+
+Disable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled false
+```
+
+Enable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "4.1.0-beta.4198b60",
+  "version": "4.1.0-beta.6c0929c",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/index.js",