@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.bb31388

package/docs/docs/cmd/spo/roledefinition/roledefinition-add.mdx

@@ -0,0 +1,51 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo roledefinition add
+
+Adds a new roledefinition to web
+
+## Usage
+
+```sh
+m365 spo roledefinition add [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site to which role should be added.
+
+`-n, --name <name>`
+: role definition name.
+
+`-d, --description [description]`
+: role definition description.
+
+`--rights [rights]`
+: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`,`UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Default `EmptyMask`.
+```
+
+<Global />
+
+## Remarks
+
+The `--rights` option accepts **case-sensitive** values.
+
+## Examples
+
+Adds the role definition for the given site
+
+```sh
+m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test
+```
+
+Adds the role definition for the given site with description and rights
+
+```sh
+m365 spo roledefinition add --webUrl https://contoso.sharepoint.com/sites/project-x --name test --description "test description" --rights "ViewListItems,AddListItems,EditListItems,DeleteListItems"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/roledefinition/roledefinition-get.mdx

@@ -0,0 +1,139 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo roledefinition get
+
+Gets specified role definition from web
+
+## Usage
+
+```sh
+m365 spo roledefinition get [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve the role definition.
+
+`-i, --id <id>`
+: The Id of the role definition to retrieve.
+```
+
+<Global />
+
+## Examples
+
+Retrieve the role definition for the given site
+
+```sh
+m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "BasePermissions": {
+      "High": "2147483647",
+      "Low": "4294967295"
+    },
+    "Description": "Has full control.",
+    "Hidden": false,
+    "Id": 1073741829,
+    "Name": "Full Control",
+    "Order": 1,
+    "RoleTypeKind": 5,
+    "BasePermissionsValue": [
+      "ViewListItems",
+      "AddListItems",
+      "EditListItems",
+      "DeleteListItems",
+      "ApproveItems",
+      "OpenItems",
+      "ViewVersions",
+      "DeleteVersions",
+      "CancelCheckout",
+      "ManagePersonalViews",
+      "ManageLists",
+      "ViewFormPages",
+      "AnonymousSearchAccessList",
+      "Open",
+      "ViewPages",
+      "AddAndCustomizePages",
+      "ApplyThemeAndBorder",
+      "ApplyStyleSheets",
+      "ViewUsageData",
+      "CreateSSCSite",
+      "ManageSubwebs",
+      "CreateGroups",
+      "ManagePermissions",
+      "BrowseDirectories",
+      "BrowseUserInfo",
+      "AddDelPrivateWebParts",
+      "UpdatePersonalWebParts",
+      "ManageWeb",
+      "AnonymousSearchAccessWebLists",
+      "UseClientIntegration",
+      "UseRemoteAPIs",
+      "ManageAlerts",
+      "CreateAlerts",
+      "EditMyUserInfo",
+      "EnumeratePermissions"
+    ],
+    "RoleTypeKindValue": "Administrator"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  BasePermissions     : {"High":"2147483647","Low":"4294967295"}
+  BasePermissionsValue: ["ViewListItems","AddListItems","EditListItems","DeleteListItems","ApproveItems","OpenItems","ViewVersions","DeleteVersions","CancelCheckout","ManagePersonalViews","ManageLists","ViewFormPages","AnonymousSearchAccessList","Open","ViewPages","AddAndCustomizePages","ApplyThemeAndBorder","ApplyStyleSheets","ViewUsageData","CreateSSCSite","ManageSubwebs","CreateGroups","ManagePermissions","BrowseDirectories","BrowseUserInfo","AddDelPrivateWebParts","UpdatePersonalWebParts","ManageWeb","AnonymousSearchAccessWebLists","UseClientIntegration","UseRemoteAPIs","ManageAlerts","CreateAlerts","EditMyUserInfo","EnumeratePermissions"]
+  Description         : Has full control.
+  Hidden              : false
+  Id                  : 1073741829
+  Name                : Full Control
+  Order               : 1
+  RoleTypeKind        : 5
+  RoleTypeKindValue   : Administrator
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  BasePermissions,Description,Hidden,Id,Name,Order,RoleTypeKind,BasePermissionsValue,RoleTypeKindValue
+  "{""High"":""2147483647"",""Low"":""4294967295""}",Has full control.,,1073741829,Full Control,1,5,"[""ViewListItems"",""AddListItems"",""EditListItems"",""DeleteListItems"",""ApproveItems"",""OpenItems"",""ViewVersions"",""DeleteVersions"",""CancelCheckout"",""ManagePersonalViews"",""ManageLists"",""ViewFormPages"",""AnonymousSearchAccessList"",""Open"",""ViewPages"",""AddAndCustomizePages"",""ApplyThemeAndBorder"",""ApplyStyleSheets"",""ViewUsageData"",""CreateSSCSite"",""ManageSubwebs"",""CreateGroups"",""ManagePermissions"",""BrowseDirectories"",""BrowseUserInfo"",""AddDelPrivateWebParts"",""UpdatePersonalWebParts"",""ManageWeb"",""AnonymousSearchAccessWebLists"",""UseClientIntegration"",""UseRemoteAPIs"",""ManageAlerts"",""CreateAlerts"",""EditMyUserInfo"",""EnumeratePermissions""]",Administrator
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo roledefinition get --webUrl "https://contoso.sharepoint.com/sites/project-x" --id "1073741829"
+
+  Date: 5/6/2023
+
+  ## Full Control (1073741829)
+
+  Property | Value
+  ---------|-------
+  Description | Has full control.
+  Hidden | false
+  Id | 1073741829
+  Name | Full Control
+  Order | 1
+  RoleTypeKind | 5
+  RoleTypeKindValue | Administrator
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/roledefinition/roledefinition-list.mdx

@@ -0,0 +1,132 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo roledefinition list
+
+Gets list of role definitions for the specified site
+
+## Usage
+
+```sh
+m365 spo roledefinition list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve role definitions.
+```
+
+<Global />
+
+## Examples
+
+Return list of role definitions for the given site
+
+```sh
+m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "BasePermissions": {
+        "High": 2147483647,
+        "Low": 4294967295
+      },
+      "Description": "Has full control.",
+      "Hidden": false,
+      "Id": 1073741829,
+      "Name": "Full Control",
+      "Order": 1,
+      "RoleTypeKind": 5,
+      "BasePermissionsValue": [
+        "ViewListItems",
+        "AddListItems",
+        "EditListItems",
+        "DeleteListItems",
+        "ApproveItems",
+        "OpenItems",
+        "ViewVersions",
+        "DeleteVersions",
+        "CancelCheckout",
+        "ManagePersonalViews",
+        "ManageLists",
+        "ViewFormPages",
+        "AnonymousSearchAccessList",
+        "Open",
+        "ViewPages",
+        "AddAndCustomizePages",
+        "ApplyThemeAndBorder",
+        "ApplyStyleSheets",
+        "ViewUsageData",
+        "CreateSSCSite",
+        "ManageSubwebs",
+        "CreateGroups",
+        "ManagePermissions",
+        "BrowseDirectories",
+        "BrowseUserInfo",
+        "AddDelPrivateWebParts",
+        "UpdatePersonalWebParts",
+        "ManageWeb",
+        "AnonymousSearchAccessWebLists",
+        "UseClientIntegration",
+        "UseRemoteAPIs",
+        "ManageAlerts",
+        "CreateAlerts",
+        "EditMyUserInfo",
+        "EnumeratePermissions"
+      ],
+      "RoleTypeKindValue": "Administrator"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Id          Name
+  ----------  -----------------------
+  1073741829  Full Control
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Id,Name
+  1073741829,Full Control
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo roledefinition list --webUrl "https://contoso.sharepoint.com/sites/project-x"
+
+  Date: 5/6/2023
+
+  ## Full Control (1073741829)
+
+  Property | Value
+  ---------|-------
+  Description | Has full control.
+  Hidden | false
+  Id | 1073741829
+  Name | Full Control
+  Order | 1
+  RoleTypeKind | 5
+  RoleTypeKindValue | Administrator
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/roledefinition/roledefinition-remove.mdx

@@ -0,0 +1,44 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo roledefinition remove
+
+Removes the role definition from the specified site
+
+## Usage
+
+```sh
+m365 spo roledefinition remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: URL of the site from which role should be removed.
+
+`-i, --id <id>`
+: ID of the role definition to remove.
+
+`--confirm`
+: Don't prompt for confirming removing the role definition.
+```
+
+<Global />
+
+## Examples
+
+Remove the role definition from the given site
+
+```sh
+m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
+```
+
+Remove the role definition from the given site and don't prompt for confirmation
+
+```sh
+m365 spo roledefinition remove --webUrl https://contoso.sharepoint.com/sites/project-x --id 1 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-add.mdx

@@ -0,0 +1,118 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo serviceprincipal grant add
+
+Grants the service principal permission to the specified API
+
+## Usage
+
+```sh
+m365 spo serviceprincipal grant add [options]
+```
+
+## Alias
+
+```sh
+m365 spo sp grant add
+```
+
+## Options
+
+```md defintion-list
+`-r, --resource <resource>`
+: The name of the resource for which permissions should be granted.
+
+`-s, --scope <scope>`
+: The name of the permission that should be granted.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global administrator.
+
+:::
+
+## Examples
+
+Grant the service principal permission to read email using the Microsoft Graph
+
+```sh
+m365 spo serviceprincipal grant add --resource 'Microsoft Graph' --scope 'Mail.Read'
+```
+
+Grant the service principal permission to a custom API
+
+```sh
+m365 spo serviceprincipal grant add --resource 'contoso-api' --scope 'user_impersonation'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
+    "ConsentType": "AllPrincipals",
+    "IsDomainIsolated": false,
+    "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
+    "PackageName": null,
+    "Resource": "Microsoft Graph",
+    "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
+    "Scope": "Mail.Read"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
+  ConsentType     : AllPrincipals
+  IsDomainIsolated: false
+  ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
+  PackageName     : null
+  Resource        : Microsoft Graph
+  ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
+  Scope           : Mail.Read
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+  6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo serviceprincipal grant add --resource "Microsoft Graph" --scope "Mail.Read"
+
+  Date: 5/7/2023
+
+  ## 4WtBzD8u5kW-sYuikIWL_8ZYTP5mJB1LnC6OT4Ibr94
+
+  Property | Value
+  ---------|-------
+  ClientId | cc416be1-2e3f-45e6-beb1-8ba290858bff
+  ConsentType | AllPrincipals
+  IsDomainIsolated | false
+  ObjectId | 4WtBzD8u5kW-sYuikIWL\_8ZYTP5mJB1LnC6OT4Ibr94
+  Resource | Microsoft Graph
+  ResourceId | fe4c58c6-2466-4b1d-9c2e-8e4f821bafde
+  Scope | Mail.Read
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo serviceprincipal grant list
+
+Lists permissions granted to the service principal
+
+## Usage
+
+```sh
+m365 spo serviceprincipal grant list [options]
+```
+
+## Alias
+
+```sh
+m365 spo sp grant list
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global administrator.
+
+:::
+
+## Examples
+
+List all permissions granted to the service principal
+
+```sh
+m365 spo serviceprincipal grant list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "IsDomainIsolated": false,
+      "ObjectId": "QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E",
+      "PackageName": null,
+      "Resource": "Windows Azure Active Directory",
+      "ResourceId": "b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1",
+      "Scope": "User.Read"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  IsDomainIsolated  ObjectId                                     PackageName  Resource                        ResourceId                            Scope
+  ----------------  -------------------------------------------  -----------  ------------------------------  ------------------------------------  --------------------------
+  false             QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E  null         Windows Azure Active Directory  b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1  User.Read
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
+  ,QqYEYFwYmkeZKhXRwj4iKV5QwbD60RVCo6xeMUG407E,,Windows Azure Active Directory,b0c1505e-d1fa-4215-a3ac-5e3141b8d3b1,User.Read
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo serviceprincipal grant list 
+
+  Date: 5/7/2023
+
+  ## 4WtBzD8u5kW-sYuikIWL_8ZYTP5mJB1LnC6OT4Ibr94
+
+  Property | Value
+  ---------|-------
+  IsDomainIsolated | false
+  ObjectId | 4WtBzD8u5kW-sYuikIWL\_8ZYTP5mJB1LnC6OT4Ibr94
+  Resource | Microsoft Graph
+  ResourceId | fe4c58c6-2466-4b1d-9c2e-8e4f821bafde
+  Scope | Mail.Read
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-revoke.mdx

@@ -0,0 +1,48 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo serviceprincipal grant revoke
+
+Revokes the specified set of permissions granted to the service principal
+
+## Usage
+
+```sh
+m365 spo serviceprincipal grant revoke [options]
+```
+
+## Alias
+
+```sh
+m365 spo sp grant revoke
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: `ObjectId` of the permission grant to revoke.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global administrator.
+
+:::
+
+The permission grant you want to revoke is denoted using its `ObjectId`. You can retrieve it using the [spo serviceprincipal grant list](./serviceprincipal-grant-list.mdx) command.
+
+## Examples
+
+Revoke permission grant
+
+```sh
+m365 spo serviceprincipal grant revoke --id 50NAzUm3C0K9B6p8ORLtIsQccg4rMERGvFGRtBsk2fA
+```
+
+## Response
+
+The command won't return a response on success.