@pnp/cli-microsoft365 7.10.0-beta.ebb7426 → 7.11.0-beta.c513557

package/dist/m365/spo/commands/site/site-admin-list.js

@@ -0,0 +1,144 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoSiteAdminListCommand_instances, _SpoSiteAdminListCommand_initTelemetry, _SpoSiteAdminListCommand_initOptions, _SpoSiteAdminListCommand_initValidators, _SpoSiteAdminListCommand_initTypes;
+import request from '../../../../request.js';
+import { spo } from '../../../../utils/spo.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+import { ListPrincipalType } from '../list/ListPrincipalType.js';
+class SpoSiteAdminListCommand extends SpoCommand {
+    get name() {
+        return commands.SITE_ADMIN_LIST;
+    }
+    get description() {
+        return 'Lists all administrators of a specific SharePoint site';
+    }
+    constructor() {
+        super();
+        _SpoSiteAdminListCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoSiteAdminListCommand_instances, "m", _SpoSiteAdminListCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoSiteAdminListCommand_instances, "m", _SpoSiteAdminListCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoSiteAdminListCommand_instances, "m", _SpoSiteAdminListCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoSiteAdminListCommand_instances, "m", _SpoSiteAdminListCommand_initTypes).call(this);
+    }
+    async commandAction(logger, args) {
+        try {
+            if (args.options.asAdmin) {
+                await this.callActionAsAdmin(logger, args);
+                return;
+            }
+            await this.callAction(logger, args);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async callActionAsAdmin(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr('Retrieving site administrators as an administrator...');
+        }
+        const adminUrl = await spo.getSpoAdminUrl(logger, this.debug);
+        const siteId = await this.getSiteId(args.options.siteUrl, logger);
+        const requestOptions = {
+            url: `${adminUrl}/_api/SPO.Tenant/GetSiteAdministrators?siteId='${siteId}'`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'application/json;charset=utf-8'
+            }
+        };
+        const response = await request.post(requestOptions);
+        const responseContent = JSON.parse(response);
+        const primaryAdminLoginName = await this.getPrimaryAdminLoginNameFromAdmin(adminUrl, siteId);
+        const mappedResult = responseContent.value.map((u) => ({
+            Id: null,
+            Email: u.email,
+            LoginName: u.loginName,
+            Title: u.name,
+            PrincipalType: null,
+            PrincipalTypeString: null,
+            IsPrimaryAdmin: u.loginName === primaryAdminLoginName
+        }));
+        await logger.log(mappedResult);
+    }
+    async getSiteId(siteUrl, logger) {
+        const siteGraphId = await spo.getSiteId(siteUrl, logger, this.verbose);
+        const match = siteGraphId.match(/,([a-f0-9\-]{36}),/i);
+        if (!match) {
+            throw `Site with URL ${siteUrl} not found`;
+        }
+        return match[1];
+    }
+    async getPrimaryAdminLoginNameFromAdmin(adminUrl, siteId) {
+        const requestOptions = {
+            url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'application/json;charset=utf-8'
+            }
+        };
+        const response = await request.get(requestOptions);
+        const responseContent = JSON.parse(response);
+        return responseContent.OwnerLoginName;
+    }
+    async callAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr('Retrieving site administrators...');
+        }
+        const requestOptions = {
+            url: `${args.options.siteUrl}/_api/web/siteusers?$filter=IsSiteAdmin eq true`,
+            method: 'GET',
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const responseContent = await request.get(requestOptions);
+        const primaryOwnerLogin = await this.getPrimaryOwnerLoginFromSite(args.options.siteUrl);
+        const mappedResult = responseContent.value.map((u) => ({
+            Id: u.Id,
+            LoginName: u.LoginName,
+            Title: u.Title,
+            PrincipalType: u.PrincipalType,
+            PrincipalTypeString: ListPrincipalType[u.PrincipalType],
+            Email: u.Email,
+            IsPrimaryAdmin: u.LoginName === primaryOwnerLogin
+        }));
+        await logger.log(mappedResult);
+    }
+    async getPrimaryOwnerLoginFromSite(siteUrl) {
+        const requestOptions = {
+            url: `${siteUrl}/_api/site/owner`,
+            method: 'GET',
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const responseContent = await request.get(requestOptions);
+        return responseContent?.LoginName ?? null;
+    }
+}
+_SpoSiteAdminListCommand_instances = new WeakSet(), _SpoSiteAdminListCommand_initTelemetry = function _SpoSiteAdminListCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            siteUrl: typeof args.options.siteUrl !== 'undefined',
+            asAdmin: !!args.options.asAdmin
+        });
+    });
+}, _SpoSiteAdminListCommand_initOptions = function _SpoSiteAdminListCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --siteUrl <siteUrl>'
+    }, {
+        option: '--asAdmin'
+    });
+}, _SpoSiteAdminListCommand_initValidators = function _SpoSiteAdminListCommand_initValidators() {
+    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.siteUrl));
+}, _SpoSiteAdminListCommand_initTypes = function _SpoSiteAdminListCommand_initTypes() {
+    this.types.string.push('siteUrl');
+};
+export default new SpoSiteAdminListCommand();
+//# sourceMappingURL=site-admin-list.js.map

package/dist/m365/spo/commands.js

@@ -239,6 +239,7 @@ export default {
     SERVICEPRINCIPAL_SET: `${prefix} serviceprincipal set`,
     SET: `${prefix} set`,
     SITE_ADD: `${prefix} site add`,
+    SITE_ADMIN_LIST: `${prefix} site admin list`,
     SITE_APPCATALOG_ADD: `${prefix} site appcatalog add`,
     SITE_APPCATALOG_LIST: `${prefix} site appcatalog list`,
     SITE_APPCATALOG_REMOVE: `${prefix} site appcatalog remove`,

package/docs/docs/cmd/entra/app/app-permission-remove.mdx

@@ -14,19 +14,19 @@ m365 entra app permission remove [options]
 
 ```md definition-list
 `-i, --appId [appId]`
-: Client ID of the Microsoft Entra app to add the API permissions to. Specify either `appId`, `appName` or `appObjectId`.
+: Client ID of the Microsoft Entra app to remove the API permissions from. Specify either `appId`, `appName` or `appObjectId`.
 
 `--appObjectId [appObjectId]`
-: Object ID of the Microsoft Entra app to add the API permissions to. Specify either `appId`, `appName` or `appObjectId`.
+: Object ID of the Microsoft Entra app to remove the API permissions from. Specify either `appId`, `appName` or `appObjectId`.
 
 `-n, --appName [appName]`
 : Display name of the Entra app to remove the API permissions from. Specify either `appId`, `appName` or `appObjectId`.
 
 `-a, --applicationPermissions [applicationPermissions]`
-: Space-separated list of application permissions to add. Specify at least `applicationPermissions` or `delegatedPermissions`.
+: Space-separated list of application permissions to remove. Specify at least `applicationPermissions` or `delegatedPermissions`.
 
 `-d, --delegatedPermissions [delegatedPermissions]`
-: Space-separated list of delegated permissions to add. Specify at least `applicationPermissions` or `delegatedPermissions`.
+: Space-separated list of delegated permissions to remove. Specify at least `applicationPermissions` or `delegatedPermissions`.
 
 `--revokeAdminConsent`
 : When specified, revokes the admin consent for the specified permissions as well.

package/docs/docs/cmd/spo/site/site-admin-list.mdx

@@ -0,0 +1,115 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo site admin list
+
+Lists all administrators of a specific SharePoint site
+
+## Usage
+
+```sh
+m365 spo site admin list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the SharePoint site
+
+`--asAdmin`
+: List admins as admin for sites you don't have permission to
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command with the `--asAdmin` mode, you must have permission to access the tenant admin site.
+
+Without this parameter, you must have site collection admin permissions for the requested site.
+
+In `--asAdmin` mode, the Id, PrincipalType, and PrincipalTypeString properties are not exported.
+
+:::
+
+## Examples
+
+Lists all admins of a SharePoint site
+
+```sh
+m365 spo site admin list --siteUrl https://contoso.sharepoint.com
+```
+
+Lists all admins of a SharePoint site as admin
+
+```sh
+m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Id": 6,
+      "LoginName": "i:0#.f|membership|user@contoso.com",
+      "Title": "User Example",
+      "PrincipalType": 1,
+      "PrincipalTypeString": "User",
+      "Email": "user@contoso.com",
+      "IsPrimaryAdmin": true
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Email               : user@contoso.com
+  Id                  : 6
+  LoginName           : i:0#.f|membership|user@contoso.com
+  PrincipalType       : 1
+  PrincipalTypeString : User
+  Title               : User Example
+  IsPrimaryAdmin      : true
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Id,LoginName,Title,PrincipalType,PrincipalTypeString,Email,IsPrimaryAdmin
+  6,i:0#.f|membership|user@contoso.com,User Example,1,User,user@contoso.com,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo site admin list --siteUrl "https://contoso.sharepoint.com/sites/Test"
+
+  Date: 20/03/2024
+
+  ## User
+
+  Property | Value
+  ---------|-------
+  Id | 6
+  LoginName | i:0#.f\|membership\|user@contoso.com
+  Title | User Example
+  PrincipalType | 1
+  PrincipalTypeString | User
+  Email | user@contoso.com
+  IsPrimaryAdmin | true
+  ```
+
+  </TabItem>
+</Tabs>

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.10.0",
+  "version": "7.11.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "7.10.0",
+      "version": "7.11.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-common": "^14.11.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.10.0-beta.ebb7426",
+  "version": "7.11.0-beta.c513557",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",