API Reference
Command
Set-ADXUser
Updates a single Active Directory user with typed parameters and custom attribute support.
Examples
Generated fallback example from command syntax.
Set-ADXUser -Identity 'Value'
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Set-ADXUser -Identity <string> [-Attribute <Hashtable>] [-ClearAttribute <string[]>] [-Company <string>] [-Department <string>] [-Description <string>] [-DisplayName <string>] [-Domain <string>] [-Enabled <bool>] [-ExtensionAttribute <Hashtable>] [-GivenName <string>] [-Initials <string>] [-Mail <string>] [-ManagedBy <string>] [-Mobile <string>] [-Office <string>] [-Surname <string>] [-TelephoneNumber <string>] [-Title <string>] [-UserPrincipalName <string>] [<CommonParameters>]#Parameters
- Identity string
- Gets or sets user identity (sAMAccountName, UPN, DN, or name). Mail and UserPrincipalName (long form) are intentionally excluded to avoid collisions with dedicated update parameters. UPN shorthand is retained for discoverability.
- Attribute Hashtable
- Gets or sets arbitrary custom attributes to write.
- ClearAttribute string[]
- Gets or sets attributes to clear.
- Company string
- Gets or sets company.
- Department string
- Gets or sets department.
- Description string
- Gets or sets description.
- DisplayName string
- Gets or sets displayName.
- Domain string
- Gets or sets the optional domain DNS name.
- Enabled bool
- Gets or sets enabled state.
- ExtensionAttribute Hashtable
- Gets or sets extension attributes to write. Keys accept numeric indexes (1-15) or extensionAttribute1-15.
- GivenName string
- Gets or sets givenName.
- Initials string
- Gets or sets initials.
- Mail string
- Gets or sets mail.
- ManagedBy string
- Gets or sets managedBy.
- Mobile string
- Gets or sets mobile.
- Office string
- Gets or sets office (physicalDeliveryOfficeName).
- Surname string
- Gets or sets surname (sn).
- TelephoneNumber string
- Gets or sets telephoneNumber.
- Title string
- Gets or sets title.
- UserPrincipalName string
- Gets or sets userPrincipalName.
Outputs
ADPlayground.DirectoryMutationResult