Set-IDUser
SYNOPSIS
Update a user’s base profile
SYNTAX
Set-IDUser [-ID] <String> [[-Name] <String>] [[-Mail] <String>] [[-DisplayName] <String>]
[[-Description] <String>] [[-MobileNumber] <String>] [[-HomeNumber] <String>] [[-OfficeNumber] <String>]
[[-OrgPath] <String>] [[-ReportsTo] <String>] [[-CmaRedirectedUserUuid] <String>]
[[-PreferredCulture] <String>] [[-AccountExp] <DateTime>] [-ServiceUser] [-InEverybodyRole] [-VerifyEmail]
[-ForcePasswordChangeNext] [-PasswordNeverExpire] [-useAlternateMfaAccount] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Updates the base profile of an existing user.
EXAMPLES
Example 1
PS C:\> Set-IDUser -ID 'a1b2c3d4-0000-0000-0000-000000000000' -DisplayName 'Updated Name'
Updates the display name of the specified user.
PARAMETERS
-AccountExp
The date on which the user’s account expires.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CmaRedirectedUserUuid
The UUID of the user to redirect this account’s authentication to, if applicable.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
An updated description for the user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayName
An updated display name for the user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForcePasswordChangeNext
Requires the user to change their password on next login.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HomeNumber
An updated home phone number.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ID
The unique ID of the user to update.
Type: String
Parameter Sets: (All)
Aliases: Uuid
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InEverybodyRole
Includes the user in the tenant’s “Everybody” role.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
An updated email address.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MobileNumber
An updated mobile phone number.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
An updated username.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OfficeNumber
An updated office phone number.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OrgPath
An updated organizational path.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PasswordNeverExpire
Sets the user’s password to never expire.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PreferredCulture
The user’s preferred culture/locale.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReportsTo
An updated manager username.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ServiceUser
Marks the user as a service user.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VerifyEmail
Requires the user to verify their email address.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-useAlternateMfaAccount
Allows the user to use an alternate account for MFA.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.