Skip to content

Fixes 'm365 spo serviceprincipal permissionrequest list' issue #6793

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fixes 'm365 spo serviceprincipal permissionrequest list' issue #6793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df53fe6
Ensure 'm365 spo serviceprincipal permissionrequest list' returns the…
Saurabh7019 Jul 10, 2025
2666705
addressed code review feedback
Saurabh7019 Jul 19, 2025
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
31 changes: 11 additions & 20 deletions src/m365/spo/commands/serviceprincipal/serviceprincipal-permissionrequest-list.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {
let log: string[];
let logger: Logger;
let loggerLogSpy: sinon.SinonSpy;
const spoServicePrincipalDisplayName = 'SharePoint Online Web Client Extensibility';
const oAuth2PermissionGrantsResponse = {
value: [
{
Expand All @@ -39,7 +40,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {
deletedDateTime: null,
accountEnabled: true,
alternativeNames: [],
appDisplayName: 'SharePoint Online Client Extensibility Web Application Principal',
appDisplayName: spoServicePrincipalDisplayName,
appDescription: null,
appId: '912a70e1-da16-417d-a789-57c122d180cd',
applicationTemplateId: null,
Expand All @@ -48,7 +49,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {
createdDateTime: '2022-09-20T13:02:57Z',
description: null,
disabledByMicrosoftStatus: null,
displayName: 'SharePoint Online Client Extensibility Web Application Principal',
displayName: spoServicePrincipalDisplayName,
homepage: null,
loginUrl: null,
logoutUrl: null,
Expand Down Expand Up @@ -161,7 +162,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {

it('lists pending permission requests (debug)', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return spoClientExtensibilityWebApplicationPrincipalResponse;
}

Expand Down Expand Up @@ -207,7 +208,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {

it('lists pending permission requests', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return spoClientExtensibilityWebApplicationPrincipalResponse;
}

Expand Down Expand Up @@ -253,7 +254,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {

it('lists pending permission requests when no service principal is found', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return { value: [] };
}

Expand Down Expand Up @@ -285,17 +286,12 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {
throw 'Invalid request';
});
await command.action(logger, { options: {} });
assert(loggerLogSpy.calledWith([{
Id: '4dc4c043-25ee-40f2-81d3-b3bf63da7538',
Resource: 'Microsoft Graph',
ResourceId: 'Microsoft Graph',
Scope: 'Mail.Read'
}]));
assert(loggerLogSpy.calledWith([]));
});

it('lists pending permission requests when no oAuth2Permissiongrants are found', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return spoClientExtensibilityWebApplicationPrincipalResponse;
}

Expand Down Expand Up @@ -331,17 +327,12 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {
throw 'Invalid request';
});
await command.action(logger, { options: {} });
assert(loggerLogSpy.calledWith([{
Id: '4dc4c043-25ee-40f2-81d3-b3bf63da7538',
Resource: 'Microsoft Graph',
ResourceId: 'Microsoft Graph',
Scope: 'Mail.Read'
}]));
assert(loggerLogSpy.calledWith([]));
});

it('correctly handles error when retrieving pending permission requests', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return spoClientExtensibilityWebApplicationPrincipalResponse;
}

Expand All @@ -367,7 +358,7 @@ describe(commands.SERVICEPRINCIPAL_PERMISSIONREQUEST_LIST, () => {

it('correctly handles random API error', async () => {
sinon.stub(request, 'get').callsFake(async (opts) => {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`) {
if (opts.url === `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq '${spoServicePrincipalDisplayName}'`) {
return spoClientExtensibilityWebApplicationPrincipalResponse;
}

Expand Down
26 changes: 16 additions & 10 deletions src/m365/spo/commands/serviceprincipal/serviceprincipal-permissionrequest-list.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,15 @@ class SpoServicePrincipalPermissionRequestListCommand extends SpoCommand {
const result: SPOWebAppServicePrincipalPermissionRequest[] = json[json.length - 1]._Child_Items_;
if (result.length > 0) {
const spoClientExtensibilityWebApplicationPrincipalId = await this.getSPOClientExtensibilityWebApplicationPrincipalId();

if (spoClientExtensibilityWebApplicationPrincipalId !== null) {
const oAuth2PermissionGrants: string[] | null = await this.getOAuth2PermissionGrants(spoClientExtensibilityWebApplicationPrincipalId);

if (oAuth2PermissionGrants) {
spoWebAppServicePrincipalPermissionRequestResult = result.filter(x => oAuth2PermissionGrants.indexOf(x.Scope) === -1);
}
}
}

if (spoWebAppServicePrincipalPermissionRequestResult.length === 0) {
spoWebAppServicePrincipalPermissionRequestResult = result;
}

await logger.log(spoWebAppServicePrincipalPermissionRequestResult.map(r => {
return {
Expand All @@ -89,16 +85,26 @@ class SpoServicePrincipalPermissionRequestListCommand extends SpoCommand {
};

const response: ODataResponse<OAuth2PermissionGrant> = await request.get<ODataResponse<OAuth2PermissionGrant>>(requestOptions);
if (response.value && response.value.length > 0) {
return response.value[0].scope!.split(' ');
if (!response.value || response.value.length === 0) {
return null;
}

return null;
const scopes: string[] = [];
response.value.forEach(grant => {
if (grant.scope) {
grant.scope.split(' ')
.map(permission => permission.trim())
.filter(Boolean)
.forEach(permission => scopes.push(permission));
}
});

return scopes;
}

private async getSPOClientExtensibilityWebApplicationPrincipalId(): Promise<string | null> {
const requestOptions: CliRequestOptions = {
url: `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Client Extensibility Web Application Principal'`,
url: `https://graph.microsoft.com/v1.0/servicePrincipals/?$filter=displayName eq 'SharePoint Online Web Client Extensibility'`,
headers: {
accept: 'application/json;odata.metadata=none'
},
Expand Down
Loading