Remove-NectarUserAccount
- 18 Oct 2022
- 1 Minute to read
- Print
- DarkLight
- PDF
Remove-NectarUserAccount
- Updated on 18 Oct 2022
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Removes one or more Nectar DXP user accounts.
Syntax
Remove-NectarUserAccount
-EmailAddress <String>
-TenantName <String>
-Identity <String>
Examples
Example 1
Remove-NectarUserAccount tferguson@nectarcorp.com
Removes the user account tferguson@nectarcorp.com
Parameters
-EmailAddress <String>
The email address of the user account to remove.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Identity <String>
The numerical ID of the admin account to remove. Can be obtained via Get-NectarUserAccount and pipelined to Remove-NectarUserAccount
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?