Skip to content

add add, revoke and list grants functionality to ServicePrincipal #1132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jansenbe merged 3 commits into from
Mar 10, 2023
Merged

add add, revoke and list grants functionality to ServicePrincipal #1132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c74bd9e
add add, revoke and list grants functionality to ServicePrincipal
mloitzl Mar 10, 2023
6f349bc
add newlines at end of file
mloitzl Mar 10, 2023
0c2e796
add some documentation
mloitzl Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/using-the-sdk/admin-sharepoint-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,30 @@ var result = await appManager.ServicePrincipal.ApprovePermissionRequestAsync(per
// Deny a permission request
await appManager.ServicePrincipal.DenyPermissionRequestAsync(permissionRequests.First().Id.ToString());
```

## Add, list and revoke permission grants of the SharePoint app service principal

Permission grants can be added and revoked to/from the SharePoint app service principal via code.

```csharp
// Add a grant to the ServicePrincipal
var appManager = context.GetTenantAppManager();
IPermissionGrant addResult = appManager.ServicePrincipal
.AddGrant("Microsoft Graph", "Calendars.ReadWrite.Shared");

// Revoke a grant from the ServicePrincipal
var appManager = context.GetTenantAppManager();
IPermissionGrant revokeResult = appManager.ServicePrincipal.RevokeGrant(addResult.ObjectId);
```

Permissions granted to the the SharePoint app service principal can be listed via code.

```csharp
// List grants from the ServicePrincipal
var appManager = context.GetTenantAppManager();
IEnumerable<IPermissionGrant> result = appManager.ServicePrincipal.ListGrants();
```

## Enable or disable the SharePoint app service principal

The SharePoint app service principal can be enabled or disabled using the Azure Active Directory portal or via code. The `Enable` and `Disable` operations can be found on the `IServicePrincipal` interface:
Expand Down
1 change: 1 addition & 0 deletions ...st/SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-0-00000.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"37d99da0-d052-6000-2b64-1d8a6020a628","SPClientServiceRequestDuration":"12","X-SharePointHealthScore":"3","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022RegionalSettings\u0022:{\u0022TimeZone\u0022:{\u0022Description\u0022:\u0022(UTC\u002B01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna\u0022,\u0022Id\u0022:4,\u0022Information\u0022:{\u0022Bias\u0022:-60,\u0022DaylightBias\u0022:-60,\u0022StandardBias\u0022:0}},\u0022AdjustHijriDays\u0022:0,\u0022AlternateCalendarType\u0022:0,\u0022AM\u0022:\u0022AM\u0022,\u0022CalendarType\u0022:1,\u0022Collation\u0022:25,\u0022CollationLCID\u0022:2070,\u0022DateFormat\u0022:0,\u0022DateSeparator\u0022:\u0022/\u0022,\u0022DecimalSeparator\u0022:\u0022.\u0022,\u0022DigitGrouping\u0022:\u00223;0\u0022,\u0022FirstDayOfWeek\u0022:0,\u0022FirstWeekOfYear\u0022:0,\u0022IsEastAsia\u0022:false,\u0022IsRightToLeft\u0022:false,\u0022IsUIRightToLeft\u0022:false,\u0022ListSeparator\u0022:\u0022,\u0022,\u0022LocaleId\u0022:1033,\u0022NegativeSign\u0022:\u0022-\u0022,\u0022NegNumberMode\u0022:1,\u0022PM\u0022:\u0022PM\u0022,\u0022PositiveSign\u0022:\u0022\u0022,\u0022ShowWeeks\u0022:false,\u0022ThousandSeparator\u0022:\u0022,\u0022,\u0022Time24\u0022:false,\u0022TimeMarkerPosition\u0022:0,\u0022TimeSeparator\u0022:\u0022:\u0022,\u0022WorkDayEndHour\u0022:1020,\u0022WorkDays\u0022:62,\u0022WorkDayStartHour\u0022:480},\u0022Id\u0022:\u00225c1693ab-3bab-4780-812e-23bf82ba06cc\u0022,\u0022Url\u0022:\u0022https://loitzl2.sharepoint.com/sites/pnpcoresdktestgroup\u0022}"}
1 change: 1 addition & 0 deletions ...st/SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-0-00001.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"37d99da0-5059-6000-2b64-1debb2b0f43b","SPClientServiceRequestDuration":"10","X-SharePointHealthScore":"2","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022GroupId\u0022:\u0022e351a3ff-1595-4979-b588-88038f993cc6\u0022,\u0022Id\u0022:\u002269fad637-9681-4e09-b667-75b94e7898fb\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-100-00000.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"37d99da0-f073-6000-2b64-12a8a51506a9","SPClientServiceRequestDuration":"10","X-SharePointHealthScore":"1","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022RegionalSettings\u0022:{\u0022TimeZone\u0022:{\u0022Description\u0022:\u0022(UTC-08:00) Pacific Time (US and Canada)\u0022,\u0022Id\u0022:13,\u0022Information\u0022:{\u0022Bias\u0022:480,\u0022DaylightBias\u0022:-60,\u0022StandardBias\u0022:0}},\u0022AdjustHijriDays\u0022:0,\u0022AlternateCalendarType\u0022:0,\u0022AM\u0022:\u0022AM\u0022,\u0022CalendarType\u0022:1,\u0022Collation\u0022:25,\u0022CollationLCID\u0022:2070,\u0022DateFormat\u0022:0,\u0022DateSeparator\u0022:\u0022/\u0022,\u0022DecimalSeparator\u0022:\u0022.\u0022,\u0022DigitGrouping\u0022:\u00223;0\u0022,\u0022FirstDayOfWeek\u0022:0,\u0022FirstWeekOfYear\u0022:0,\u0022IsEastAsia\u0022:false,\u0022IsRightToLeft\u0022:false,\u0022IsUIRightToLeft\u0022:false,\u0022ListSeparator\u0022:\u0022,\u0022,\u0022LocaleId\u0022:1033,\u0022NegativeSign\u0022:\u0022-\u0022,\u0022NegNumberMode\u0022:1,\u0022PM\u0022:\u0022PM\u0022,\u0022PositiveSign\u0022:\u0022\u0022,\u0022ShowWeeks\u0022:false,\u0022ThousandSeparator\u0022:\u0022,\u0022,\u0022Time24\u0022:false,\u0022TimeMarkerPosition\u0022:0,\u0022TimeSeparator\u0022:\u0022:\u0022,\u0022WorkDayEndHour\u0022:1020,\u0022WorkDays\u0022:62,\u0022WorkDayStartHour\u0022:480},\u0022Id\u0022:\u002208a02a87-87f3-4c3e-ba7e-ff19e4155bd4\u0022,\u0022Url\u0022:\u0022https://loitzl2-admin.sharepoint.com\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-100-00001.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"37d99da0-7077-6000-4c7f-d77d7280660b","SPClientServiceRequestDuration":"9","X-SharePointHealthScore":"3","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022GroupId\u0022:\u002200000000-0000-0000-0000-000000000000\u0022,\u0022Id\u0022:\u00221d0f657f-36f7-4b9f-af00-94dcc1224811\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-100-00002.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"37d99da0-207c-6000-4c98-9d0a5050ccd9","SPClientServiceRequestDuration":"2346","X-SharePointHealthScore":"0","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"[\r{\r\u0022SchemaVersion\u0022:\u002215.0.0.0\u0022,\u0022LibraryVersion\u0022:\u002216.0.23422.12001\u0022,\u0022ErrorInfo\u0022:null,\u0022TraceCorrelationId\u0022:\u002237d99da0-207c-6000-4c98-9d0a5050ccd9\u0022\r},2,{\r\u0022IsNull\u0022:false\r},4,{\r\u0022IsNull\u0022:false\r},6,{\r\u0022IsNull\u0022:false\r},7,{\r\u0022_ObjectType_\u0022:\u0022Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionGrant\u0022,\u0022ClientId\u0022:\u00229b994571-2cf2-4fa4-acd0-9fe1f271410f\u0022,\u0022ConsentType\u0022:\u0022AllPrincipals\u0022,\u0022IsDomainIsolated\u0022:false,\u0022ObjectId\u0022:\u0022cUWZm_IspE-s0J_h8nFBDzH0zhmfRphIjnLf0TBUs_U\u0022,\u0022PackageName\u0022:null,\u0022Resource\u0022:\u0022Microsoft Graph\u0022,\u0022ResourceId\u0022:\u002219cef431-469f-4898-8e72-dfd13054b3f5\u0022,\u0022Scope\u0022:\u0022Calendars.ReadWrite.Shared\u0022\r}\r]"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-200-00000.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-4011-6000-4c98-9bff4091cb0e","SPClientServiceRequestDuration":"12","X-SharePointHealthScore":"1","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022RegionalSettings\u0022:{\u0022TimeZone\u0022:{\u0022Description\u0022:\u0022(UTC-08:00) Pacific Time (US and Canada)\u0022,\u0022Id\u0022:13,\u0022Information\u0022:{\u0022Bias\u0022:480,\u0022DaylightBias\u0022:-60,\u0022StandardBias\u0022:0}},\u0022AdjustHijriDays\u0022:0,\u0022AlternateCalendarType\u0022:0,\u0022AM\u0022:\u0022AM\u0022,\u0022CalendarType\u0022:1,\u0022Collation\u0022:25,\u0022CollationLCID\u0022:2070,\u0022DateFormat\u0022:0,\u0022DateSeparator\u0022:\u0022/\u0022,\u0022DecimalSeparator\u0022:\u0022.\u0022,\u0022DigitGrouping\u0022:\u00223;0\u0022,\u0022FirstDayOfWeek\u0022:0,\u0022FirstWeekOfYear\u0022:0,\u0022IsEastAsia\u0022:false,\u0022IsRightToLeft\u0022:false,\u0022IsUIRightToLeft\u0022:false,\u0022ListSeparator\u0022:\u0022,\u0022,\u0022LocaleId\u0022:1033,\u0022NegativeSign\u0022:\u0022-\u0022,\u0022NegNumberMode\u0022:1,\u0022PM\u0022:\u0022PM\u0022,\u0022PositiveSign\u0022:\u0022\u0022,\u0022ShowWeeks\u0022:false,\u0022ThousandSeparator\u0022:\u0022,\u0022,\u0022Time24\u0022:false,\u0022TimeMarkerPosition\u0022:0,\u0022TimeSeparator\u0022:\u0022:\u0022,\u0022WorkDayEndHour\u0022:1020,\u0022WorkDays\u0022:62,\u0022WorkDayStartHour\u0022:480},\u0022Id\u0022:\u002208a02a87-87f3-4c3e-ba7e-ff19e4155bd4\u0022,\u0022Url\u0022:\u0022https://loitzl2-admin.sharepoint.com\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-200-00001.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-1014-6000-2b64-1a85db2e3846","SPClientServiceRequestDuration":"11","X-SharePointHealthScore":"2","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022GroupId\u0022:\u002200000000-0000-0000-0000-000000000000\u0022,\u0022Id\u0022:\u00221d0f657f-36f7-4b9f-af00-94dcc1224811\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-200-00002.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-d015-6000-2b64-10c1a6686d4e","SPClientServiceRequestDuration":"1896","X-SharePointHealthScore":"2","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"[\r{\r\u0022SchemaVersion\u0022:\u002215.0.0.0\u0022,\u0022LibraryVersion\u0022:\u002216.0.23422.12001\u0022,\u0022ErrorInfo\u0022:null,\u0022TraceCorrelationId\u0022:\u002238d99da0-d015-6000-2b64-10c1a6686d4e\u0022\r},2,{\r\u0022IsNull\u0022:false\r},4,{\r\u0022_ObjectType_\u0022:\u0022Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionGrantCollection\u0022,\u0022_Child_Items_\u0022:[\r{\r\u0022_ObjectType_\u0022:\u0022Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionGrant\u0022,\u0022ClientId\u0022:\u00229b994571-2cf2-4fa4-acd0-9fe1f271410f\u0022,\u0022ConsentType\u0022:\u0022AllPrincipals\u0022,\u0022IsDomainIsolated\u0022:false,\u0022ObjectId\u0022:\u0022cUWZm_IspE-s0J_h8nFBDzH0zhmfRphIjnLf0TBUs_U\u0022,\u0022PackageName\u0022:null,\u0022Resource\u0022:\u0022Microsoft Graph\u0022,\u0022ResourceId\u0022:\u002219cef431-469f-4898-8e72-dfd13054b3f5\u0022,\u0022Scope\u0022:\u0022Calendars.ReadWrite.Shared\u0022\r}\r]\r}\r]"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-300-00000.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-408f-6000-4c98-9c14481651d2","SPClientServiceRequestDuration":"40","X-SharePointHealthScore":"3","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022RegionalSettings\u0022:{\u0022TimeZone\u0022:{\u0022Description\u0022:\u0022(UTC-08:00) Pacific Time (US and Canada)\u0022,\u0022Id\u0022:13,\u0022Information\u0022:{\u0022Bias\u0022:480,\u0022DaylightBias\u0022:-60,\u0022StandardBias\u0022:0}},\u0022AdjustHijriDays\u0022:0,\u0022AlternateCalendarType\u0022:0,\u0022AM\u0022:\u0022AM\u0022,\u0022CalendarType\u0022:1,\u0022Collation\u0022:25,\u0022CollationLCID\u0022:2070,\u0022DateFormat\u0022:0,\u0022DateSeparator\u0022:\u0022/\u0022,\u0022DecimalSeparator\u0022:\u0022.\u0022,\u0022DigitGrouping\u0022:\u00223;0\u0022,\u0022FirstDayOfWeek\u0022:0,\u0022FirstWeekOfYear\u0022:0,\u0022IsEastAsia\u0022:false,\u0022IsRightToLeft\u0022:false,\u0022IsUIRightToLeft\u0022:false,\u0022ListSeparator\u0022:\u0022,\u0022,\u0022LocaleId\u0022:1033,\u0022NegativeSign\u0022:\u0022-\u0022,\u0022NegNumberMode\u0022:1,\u0022PM\u0022:\u0022PM\u0022,\u0022PositiveSign\u0022:\u0022\u0022,\u0022ShowWeeks\u0022:false,\u0022ThousandSeparator\u0022:\u0022,\u0022,\u0022Time24\u0022:false,\u0022TimeMarkerPosition\u0022:0,\u0022TimeSeparator\u0022:\u0022:\u0022,\u0022WorkDayEndHour\u0022:1020,\u0022WorkDays\u0022:62,\u0022WorkDayStartHour\u0022:480},\u0022Id\u0022:\u002208a02a87-87f3-4c3e-ba7e-ff19e4155bd4\u0022,\u0022Url\u0022:\u0022https://loitzl2-admin.sharepoint.com\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-300-00001.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-7093-6000-4c98-97587007b89d","SPClientServiceRequestDuration":"20","X-SharePointHealthScore":"2","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"{\u0022GroupId\u0022:\u002200000000-0000-0000-0000-000000000000\u0022,\u0022Id\u0022:\u00221d0f657f-36f7-4b9f-af00-94dcc1224811\u0022}"}
1 change: 1 addition & 0 deletions .../SharePoint/MockData/ServicePrincipalTests/AddListRevokeGrantTest-300-00002.response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"IsSuccessStatusCode":true,"StatusCode":200,"Headers":{"SPRequestGuid":"38d99da0-1096-6000-4c98-988cb61496d1","SPClientServiceRequestDuration":"1386","X-SharePointHealthScore":"1","X-SP-SERVERSTATE":"ReadOnly=0"},"Response":"[\r{\r\u0022SchemaVersion\u0022:\u002215.0.0.0\u0022,\u0022LibraryVersion\u0022:\u002216.0.23422.12001\u0022,\u0022ErrorInfo\u0022:null,\u0022TraceCorrelationId\u0022:\u002238d99da0-1096-6000-4c98-988cb61496d1\u0022\r},2,{\r\u0022IsNull\u0022:false\r},4,{\r\u0022IsNull\u0022:false\r},6,{\r\u0022IsNull\u0022:false\r},8,{\r\u0022_ObjectType_\u0022:\u0022Microsoft.Online.SharePoint.TenantAdministration.Internal.SPOWebAppServicePrincipalPermissionGrant\u0022,\u0022ClientId\u0022:\u00229b994571-2cf2-4fa4-acd0-9fe1f271410f\u0022,\u0022ConsentType\u0022:\u0022AllPrincipals\u0022,\u0022IsDomainIsolated\u0022:false,\u0022ObjectId\u0022:\u0022cUWZm_IspE-s0J_h8nFBDzH0zhmfRphIjnLf0TBUs_U\u0022,\u0022PackageName\u0022:null,\u0022Resource\u0022:null,\u0022ResourceId\u0022:\u002219cef431-469f-4898-8e72-dfd13054b3f5\u0022,\u0022Scope\u0022:\u0022Calendars.ReadWrite.Shared\u0022\r}\r]"}
Loading