Skip to content

serviceprincipal-list-owners.md

Latest commit

 

History

History
165 lines (135 loc) · 6.54 KB

serviceprincipal-list-owners.md

File metadata and controls

165 lines (135 loc) · 6.54 KB
title List owners of a service principal
description Retrieve a list of owners of the servicePrincipal.
ms.localizationpriority high
doc_type apiPageType
ms.subservice entra-applications
author Jackson-Woods
ms.date 08/21/2024

List owners of a service principal

Namespace: microsoft.graph

Retrieve a list of owners of the servicePrincipal.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE limited-info]

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • A non-admin member or guest user with default user permissions
  • Application Developer - for the application they own
  • Directory Readers
  • Global Secure Access Administrator
  • Global Reader
  • Hybrid Identity Administrator
  • Cloud Application Administrator
  • Application Administrator

HTTP request

You can address the service principal using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.

GET /servicePrincipals/{id}/owners
GET /servicePrincipals(appId='{appId}')/owners

Optional query parameters

This method supports the $filter, $count, $orderby, $select, $search, $top, and $expand OData query parameters to help customize the response.

  • $search is supported on the displayName and description properties only.
  • The use of query parameters with this API, except for $expand, is supported only with advanced query parameters. $expand isn't supported with advanced query parameters. For more information, see Advanced query capabilities on directory objects.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of directoryObject objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/serviceprincipals/bbec3106-565f-4907-941e-96b4dbfef21c/owners

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET servicePrincipals(appId=<key>)/owners?$select=deletedDateTime",
    "value": [
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "ce4770b3-70b2-4a38-a242-76631e9f7408",
            "businessPhones": [],
            "displayName": null,
            "givenName": null,
            "jobTitle": null,
            "mail": null,
            "mobilePhone": null,
            "officeLocation": null,
            "preferredLanguage": null,
            "surname": null,
            "userPrincipalName": null
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "858a9c90-38b3-4e78-b915-234aece712c4"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "7585d967-f300-43de-b817-7119a6404c5e"
        }
    ]
}