Set-AMUser

NAME Set-AMUser



SYNOPSIS

Sets properties of an AutoMate Enterprise user.





SYNTAX

Set-AMUser -InputObject <Object> -Password <SecureString> [-Notes <String>] [-WhatIf] [-Confirm]

[<CommonParameters>]



Set-AMUser -InputObject <Object> -UseActiveDirectory [-Notes <String>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set-AMUser can change properties of a user object.





PARAMETERS

-InputObject <Object>

The object to modify.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Password <SecureString>

The password for the user.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseActiveDirectory [<SwitchParameter>]

Authenticate against Active Directory. If not specified, Automate authentication is used.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





The API requires that the password be passed in on every update call. Therefore, it is required to either

specify the -Password parameter or -UseActiveDirectory whenever calling this function, even if only updating

the Notes property for the user.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Change password for a user that authenticates against Automate



Get-AMUser -Name John | Set-AMUser -Password (Read-Host -Prompt "Enter password" -AsSecureString)











RELATED LINKS

https://github.com/AutomatePS/AutomatePS