List servicePrincipals
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Retrieve a list of servicePrincipal objects.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
Delegated (personal Microsoft account) | Not supported. |
Application | Application.ReadWrite.All, Directory.Read.All |
HTTP request
GET /servicePrincipals
Optional query parameters
This method supports the OData query parameters to help customize the response, including $search
, $count
, and $filter
. You can use $search
on the displayName property. When items are added or updated for this resource, they are specially indexed for use with the $count
and $search
query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
ConsistencyLevel | eventual. This header and $count are required when using $search , or when using $filter with the $orderby query parameter. It uses an index that may not be up-to-date with recent changes to the object. |
Request body
Do not supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and collection of servicePrincipal objects in the response body.
Examples
Example 1: Get a list of service principals
Request
GET https://graph.microsoft.com/beta/servicePrincipals
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"accountEnabled":true,
"displayName":"amasf",
"publisherName":"Contoso",
"servicePrincipalType":"Application",
"signInAudience":"AzureADMyOrg"
}
]
}
Example 2: Get only a count of service principals
Request
The following is an example of the request.
GET https://graph.microsoft.com/beta/servicePrincipals/$count
ConsistencyLevel: eventual
Response
The following is an example of the response.
HTTP/1.1 200 OK
Content-type: text/plain
893
Example 3: Use $filter and $top to get one service principal with a display name that starts with 'a' including a count of returned objects
Request
The following is an example of the request.
GET https://graph.microsoft.com/beta/servicePrincipals?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#servicePrinciples",
"@odata.count":1,
"value":[
{
"accountEnabled":true,
"displayName":"a",
"publisherName":"Contoso",
"servicePrincipalType":"Application",
"signInAudience":"AzureADMyOrg"
}
]
}
Example 4: Use $search to get service principals with display names that contain the letters 'Team' including a count of returned objects
Request
The following is an example of the request.
GET https://graph.microsoft.com/beta/servicePrincipals?$search="displayName:Team"&$count=true
ConsistencyLevel: eventual
Response
The following is an example of the response.
Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#servicePrincipals",
"@odata.count":1396,
"value":[
{
"accountEnabled":true,
"displayName":"myContosoTeam",
"publisherName":"Contoso",
"servicePrincipalType":"Application",
"signInAudience":"AzureADMyOrg"
}
]
}