Edit

Set-SPOUser

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

Configures properties on an existing user.

Syntax

Set-SPOUser
   -IsSiteCollectionAdmin <Boolean>
   -LoginName <String>
   -Site <SpoSitePipeBind>
   [<CommonParameters>]

Description

Use the Set-SPOUser cmdlet to configure properties of an existing user. That is, to add or remove a user as a SharePoint Online site collection administrator.

You must have the SharePoint Online Administrator or Global Administrator role to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at Intro to SharePoint Online Management Shell.

This cmdlet is not supported for use with granular delegated admin privileges (GDAP).

Examples

Example 1

Set-SPOUser -Site https://contoso.sharepoint.com/sites/marketing -LoginName melissa.kerr@contoso.com -IsSiteCollectionAdmin $true

This example makes melissa.kerr@contoso.com a SharePoint Online site collection administrator on https://contoso.sharepoint.com/sites/marketing.

Example 2

Set-SPOUser -Site https://contoso.sharepoint.com/sites/benefits -LoginName adelev_fabrikam.onmicrosoft.com#ext#@contoso.onmicrosoft.com -IsSiteCollectionAdmin $true

This example makes guest user adelev_fabrikam.onmicrosoft.com a SharePoint Online site collection administrator on https://contoso.sharepoint.com/sites/benefits.

Parameters

-IsSiteCollectionAdmin

Specifies whether the user is a site collection administrator.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-LoginName

Specifies the user name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-Site

Specifies the full URL of the site collection. It must be in a valid managed path in the company's site.

Type:SpoSitePipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-UpdateUserTypeFromAzureAD

If the UserType property of an existing user is changed in Microsoft Entra ID from Member to Guest or vice-versa, this parameter can be used to update it in SharePoint Online. For more information, see Convert UserType.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False