@pnp/cli-microsoft365 7.9.0 → 7.10.0-beta.a743796

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,261 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # entra pim role request list
6
+
7
+ Retrieves a list of PIM requests for roles
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 entra pim role request list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `--userId [userId]`
19
+ : Id of the user for which to list requests. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all requests will be listed.
20
+
21
+ `--userName [userName]`
22
+ : UPN of the user for which to list requests. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all requests will be listed.
23
+
24
+ `--groupId [groupId]`
25
+ : Id of the group for which to list requests. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all requests will be listed.
26
+
27
+ `--groupName [groupName]`
28
+ : Display name of the group for which to list requests. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all requests will be listed.
29
+
30
+ `-c, --createdDateTime [createdDateTime]`
31
+ : An optional ISO 8601 formatted date filter to search from.
32
+
33
+ `-s, --status [status]`
34
+ : An optional value to filter the list of requests. Allowed values are: `Canceled`, `Denied`, `Failed`, `Granted`, `PendingAdminDecision`, `PendingApproval`, `PendingProvisioning`, `PendingScheduleCreation`, `Provisioned`, `Revoked`, and `ScheduleCreated`.
35
+
36
+ `--includePrincipalDetails`
37
+ : An optional flag to include details of the principals that were assigned a role.
38
+ ```
39
+
40
+ <Global />
41
+
42
+ ## Examples
43
+
44
+ Get a list of PIM requests for roles.
45
+
46
+ ```sh
47
+ m365 entra pim role request list
48
+ ```
49
+
50
+ Get a list of PIM requests for the current user.
51
+
52
+ ```sh
53
+ m365 entra pim role request list --userId '@meID'
54
+ ```
55
+
56
+ Get a list of PIM requests for a specified user since the first of January 2024.
57
+
58
+ ```sh
59
+ m365 entra pim role request list --createdDateTime 2024-01-01T00:00:00Z
60
+ ```
61
+
62
+ Get a list of PIM requests with principal details.
63
+
64
+ ```sh
65
+ m365 entra pim role request list --includePrincipalDetails
66
+ ```
67
+
68
+ Get a list of PIM requests with pending approvals.
69
+
70
+ ```sh
71
+ m365 entra pim role request list --status PendingApproval
72
+ ```
73
+
74
+ ## Response
75
+
76
+ ### Standard response
77
+
78
+ <Tabs>
79
+ <TabItem value="JSON">
80
+
81
+ ```json
82
+ [
83
+ {
84
+ "id": "80231d2f-95a1-47a5-8339-acf3d71efec7",
85
+ "status": "Revoked",
86
+ "createdDateTime": "2024-02-12T14:08:38.82Z",
87
+ "completedDateTime": null,
88
+ "approvalId": null,
89
+ "customData": null,
90
+ "action": "adminRemove",
91
+ "principalId": "61b0c52f-a902-4769-9a09-c6628335b00a",
92
+ "roleDefinitionId": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
93
+ "directoryScopeId": "/",
94
+ "appScopeId": null,
95
+ "isValidationOnly": false,
96
+ "targetScheduleId": null,
97
+ "justification": null,
98
+ "scheduleInfo": null,
99
+ "createdBy": {
100
+ "application": null,
101
+ "device": null,
102
+ "user": {
103
+ "displayName": null,
104
+ "id": "893f9116-e024-4bc6-8e98-54c245129485"
105
+ }
106
+ },
107
+ "ticketInfo": {
108
+ "ticketNumber": null,
109
+ "ticketSystem": null
110
+ },
111
+ "roleDefinitionName": "SharePoint Administrator"
112
+ }
113
+ ]
114
+ ```
115
+
116
+ </TabItem>
117
+ <TabItem value="Text">
118
+
119
+ ```text
120
+ id roleDefinitionName principalId
121
+ ------------------------------------ ------------------------ ------------------------------------
122
+ 48eed833-155f-46ce-87f2-e02e94667dd8 SharePoint Administrator 61b0c52f-a902-4769-9a09-c6628335b00a
123
+ da1cb564-78ba-4198-b94a-613d892ed73e User Administrator 61b0c52f-a902-4769-9a09-c6628335b00a
124
+ ```
125
+
126
+ </TabItem>
127
+ <TabItem value="CSV">
128
+
129
+ ```csv
130
+ id,status,createdDateTime,completedDateTime,approvalId,customData,action,principalId,roleDefinitionId,directoryScopeId,appScopeId,isValidationOnly,targetScheduleId,justification,scheduleInfo,roleDefinitionName
131
+ da1cb564-78ba-4198-b94a-613d892ed73e,Revoked,2023-10-15T12:35:08.167Z,,,,adminRemove,61b0c52f-a902-4769-9a09-c6628335b00a,fe930be7-5e62-47db-91af-98c3a49a38b1,/administrativeUnits/0a22c83d-c4ac-43e2-bb5e-87af3015d49f,,,,,,User Administrator
132
+ 38d6295f-19e9-4945-90f4-75a2284676ea,Revoked,2024-02-12T08:19:25.037Z,,,,adminRemove,61b0c52f-a902-4769-9a09-c6628335b00a,f28a1f50-f6e7-4571-818b-6a12f2af6b6c,/administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09,,,,,,SharePoint Administrator
133
+ ```
134
+
135
+ </TabItem>
136
+ <TabItem value="Markdown">
137
+
138
+ ```md
139
+ # entra pim role request list
140
+
141
+ Date: 5/30/2024
142
+
143
+ ## da1cb564-78ba-4198-b94a-613d892ed73e
144
+
145
+ Property | Value
146
+ ---------|-------
147
+ id | da1cb564-78ba-4198-b94a-613d892ed73e
148
+ status | Revoked
149
+ createdDateTime | 2023-10-15T12:35:08.167Z
150
+ action | adminRemove
151
+ principalId | 61b0c52f-a902-4769-9a09-c6628335b00a
152
+ roleDefinitionId | fe930be7-5e62-47db-91af-98c3a49a38b1
153
+ directoryScopeId | /administrativeUnits/0a22c83d-c4ac-43e2-bb5e-87af3015d49f
154
+ isValidationOnly | false
155
+ roleDefinitionName | User Administrator
156
+ ```
157
+
158
+ </TabItem>
159
+ </Tabs>
160
+
161
+ ### `includePrincipalDetails` response
162
+
163
+ When we make use of the option `includePrincipalDetails` the response will differ.
164
+
165
+ <Tabs>
166
+ <TabItem value="JSON">
167
+
168
+ ```json
169
+ [
170
+ {
171
+ "id": "80231d2f-95a1-47a5-8339-acf3d71efec7",
172
+ "status": "Revoked",
173
+ "createdDateTime": "2024-02-12T14:08:38.82Z",
174
+ "completedDateTime": null,
175
+ "approvalId": null,
176
+ "customData": null,
177
+ "action": "adminRemove",
178
+ "principalId": "61b0c52f-a902-4769-9a09-c6628335b00a",
179
+ "roleDefinitionId": "f28a1f50-f6e7-4571-818b-6a12f2af6b6c",
180
+ "directoryScopeId": "/",
181
+ "appScopeId": null,
182
+ "isValidationOnly": false,
183
+ "targetScheduleId": null,
184
+ "justification": null,
185
+ "scheduleInfo": null,
186
+ "createdBy": {
187
+ "application": null,
188
+ "device": null,
189
+ "user": {
190
+ "displayName": null,
191
+ "id": "893f9116-e024-4bc6-8e98-54c245129485"
192
+ }
193
+ },
194
+ "ticketInfo": {
195
+ "ticketNumber": null,
196
+ "ticketSystem": null
197
+ },
198
+ "roleDefinitionName": "SharePoint Administrator",
199
+ "principal": {
200
+ "id": "61b0c52f-a902-4769-9a09-c6628335b00a",
201
+ "displayName": "John Doe",
202
+ "userPrincipalName": "JohnDoe@contoso.onmicrosoft.com",
203
+ "mail": "JohnDoe@contoso.onmicrosoft.com",
204
+ "businessPhones": [
205
+ "+1 425 555 0109"
206
+ ],
207
+ "givenName": "John",
208
+ "jobTitle": "Retail Manager",
209
+ "mobilePhone": null,
210
+ "officeLocation": "18/2111",
211
+ "preferredLanguage": "en-US",
212
+ "surname": "Doe"
213
+ }
214
+ }
215
+ ]
216
+ ```
217
+
218
+ </TabItem>
219
+ <TabItem value="Text">
220
+
221
+ ```text
222
+ id roleDefinitionName principalId
223
+ ------------------------------------ ------------------------ ------------------------------------
224
+ 48eed833-155f-46ce-87f2-e02e94667dd8 SharePoint Administrator 61b0c52f-a902-4769-9a09-c6628335b00a
225
+ da1cb564-78ba-4198-b94a-613d892ed73e User Administrator 61b0c52f-a902-4769-9a09-c6628335b00a
226
+ ```
227
+
228
+ </TabItem>
229
+ <TabItem value="CSV">
230
+
231
+ ```csv
232
+ id,status,createdDateTime,completedDateTime,approvalId,customData,action,principalId,roleDefinitionId,directoryScopeId,appScopeId,isValidationOnly,targetScheduleId,justification,scheduleInfo,roleDefinitionName
233
+ da1cb564-78ba-4198-b94a-613d892ed73e,Revoked,2023-10-15T12:35:08.167Z,,,,adminRemove,61b0c52f-a902-4769-9a09-c6628335b00a,fe930be7-5e62-47db-91af-98c3a49a38b1,/administrativeUnits/0a22c83d-c4ac-43e2-bb5e-87af3015d49f,,,,,,User Administrator
234
+ 38d6295f-19e9-4945-90f4-75a2284676ea,Revoked,2024-02-12T08:19:25.037Z,,,,adminRemove,61b0c52f-a902-4769-9a09-c6628335b00a,f28a1f50-f6e7-4571-818b-6a12f2af6b6c,/administrativeUnits/81bb36e4-f4c6-4984-8e56-d4f8feae9e09,,,,,,SharePoint Administrator
235
+ ```
236
+
237
+ </TabItem>
238
+ <TabItem value="Markdown">
239
+
240
+ ```md
241
+ # entra pim role request list --includePrincipalDetails "true"
242
+
243
+ Date: 5/30/2024
244
+
245
+ ## da1cb564-78ba-4198-b94a-613d892ed73e
246
+
247
+ Property | Value
248
+ ---------|-------
249
+ id | da1cb564-78ba-4198-b94a-613d892ed73e
250
+ status | Revoked
251
+ createdDateTime | 2023-10-15T12:35:08.167Z
252
+ action | adminRemove
253
+ principalId | 61b0c52f-a902-4769-9a09-c6628335b00a
254
+ roleDefinitionId | fe930be7-5e62-47db-91af-98c3a49a38b1
255
+ directoryScopeId | /administrativeUnits/0a22c83d-c4ac-43e2-bb5e-87af3015d49f
256
+ isValidationOnly | false
257
+ roleDefinitionName | User Administrator
258
+ ```
259
+
260
+ </TabItem>
261
+ </Tabs>
@@ -26,6 +26,9 @@ m365 spo folder add [options]
26
26
 
27
27
  `--color [color]`
28
28
  : Visual color of the folder. Valid values are a color name or a number. Check remarks for more info.
29
+
30
+ `--ensureParentFolders [ensureParentFolders]`
31
+ : Ensure that the parent folder path is available. Any missing folders will be created recursively.
29
32
  ```
30
33
 
31
34
  <Global />
@@ -79,6 +82,12 @@ Create a folder with a light teal look
79
82
  m365 spo folder add --webUrl https://contoso.sharepoint.com --url '/ProjectFiles/Project-x' --color lightTeal
80
83
  ```
81
84
 
85
+ Create a folder and make sure that any missing folders specified as parent folders are created.
86
+
87
+ ```sh
88
+ m365 spo folder add --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Projects/2024/Q1/Reports' --name Financial --ensureParentFolders
89
+ ```
90
+
82
91
  ## Response
83
92
 
84
93
  <Tabs>
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "7.9.0",
3
+ "version": "7.10.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@pnp/cli-microsoft365",
9
- "version": "7.9.0",
9
+ "version": "7.10.0",
10
10
  "license": "MIT",
11
11
  "dependencies": {
12
12
  "@azure/msal-common": "^14.10.0",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "7.9.0",
3
+ "version": "7.10.0-beta.a743796",
4
4
  "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
5
5
  "license": "MIT",
6
6
  "main": "./dist/api.js",
@@ -307,4 +307,4 @@
307
307
  "sinon": "^17.0.2",
308
308
  "source-map-support": "^0.5.21"
309
309
  }
310
- }
310
+ }