Remove-EntraUserSponsor
Removes a sponsor from a user.
Syntax
Remove-EntraUserSponsor
-UserId <String>
-SponsorId <String>
[<CommonParameters>]
Description
The Remove-EntraUserSponsor
cmdlet removes a sponsor relationship from a user. Sponsors are users and groups that are responsible for a guest's privileges in the tenant and for keeping the guest's information and access up to date. This cmdlet removes that sponsorship relationship. Specify UserId
and SponsorId
parameters to remove a user sponsor.
Examples
Example 1: Remove a user sponsor via pipelining
Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUserSponsor -UserId 'SawyerM@contoso.com' | Where-Object { $_.displayName -eq 'Adele Vance (Fabrikam)' } | Remove-EntraUserSponsor
This example demonstrates how to remove a user sponsor.
UserId
parameter specifies the UserId or User Principal Name of the User.
Example 2: Remove a user sponsor
Connect-Entra -Scopes 'User.ReadWrite.All'
$sponsor = Get-EntraUserSponsor -UserId 'SawyerM@contoso.com' -Top 1
Remove-EntraUserSponsor -UserId 'SawyerM@Contoso.com' -SponsorId $sponsor.Id
This example demonstrates how to remove a user sponsor.
UserId
parameter specifies the UserId or User Principal Name of the User.SponsorId
parameter specifies the ID of the sponsor to remove.
Parameters
-SponsorId
Specifies the ID of the sponsor (user or group) to be removed.
Type: | System.String |
Aliases: | DirectoryObjectId |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserId
Specifies the ID (as a UserPrincipalName or UserId) of a user in Microsoft Entra ID.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |