Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Assign an agentUser a sponsor. Sponsors are users and groups that are responsible for this agent user's privileges in the tenant and for keeping the agent user's information and access up to date.
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 permission | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All, User.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All, User.ReadWrite.All |
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/update role permission. The following least privileged roles are supported for this operation:
- Directory Writers
- User Administrator
- Agent ID Administrator - For agent users
HTTP request
POST /users/{usersId}/sponsors/$ref
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON object and pass an @odata.id parameter with the read URL of the user or group object to be added.
Response
If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/users/{usersId}/sponsors/$ref
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.directoryObject"
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 204 No Content
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.directoryObject",
"id": "a6c034b8-621b-dee3-6abb-52cbce801fe9",
"deletedDateTime": "String (timestamp)"
}