List sponsors
Namespace: microsoft.graph
Get a user's sponsors. Sponsors are users and groups that are responsible for this guest's privileges in the tenant and for keeping the guest's information and access up to date.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
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.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | User.Read | User.ReadWrite.All, User.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | User.Read.All | User.ReadWrite.All |
Important
When an application queries a relationship that returns a directoryObject type collection, if it doesn't have permission to read a certain resource type, members of that type are returned but with limited information. For example, only the @odata.type property for the object type and the id is returned, while other properties are indicated as null
. With this behavior, applications can request the least privileged permissions they need, rather than rely on the set of Directory.* permissions. For details, see Limited information returned for inaccessible member objects.
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 the microsoft.directory/users/sponsors/read
role permission. The following least privileged roles are supported for this operation:
- Guest Inviter
- Directory Readers
- Directory Writers
- User Administrator
HTTP request
Get sponsors.
GET /users/{id | userPrincipalName}/sponsors
Optional query parameters
This method supports the $select
and $expand
OData query parameters to help customize the response. You can specify $select
inside $expand
to select the individual sponsor's properties: $expand=sponsors($select=id,displayName)
.
Request headers
Header | Value |
---|---|
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 user and group objects in the response body.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/v1.0/users/025e5e3e-e5b7-4eb4-ba1f-4e5b0579f1a2/sponsors
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",
"value": [
{
"@odata.type": "#microsoft.graph.user",
"id": "263a1289-8282-4bf7-91f7-550d9bba8c02",
"displayName": "Sara Davis",
"jobTitle": "Finance VP",
"mail": "[email protected]",
"userPrincipalName": "[email protected]"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "08143e93-989e-4771-ac78-803bcdac52d2",
"mail": "[email protected]",
"mailEnabled": true,
"mailNickname": "groupforsponsors",
"securityEnabled": true
}
]
}