New-NectarUserAccount
- 18 Oct 2022
- 1 Minute to read
- Print
- DarkLight
- PDF
New-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
Create a new Nectar DXP user account.
Syntax
New-NectarUserAccount
-FirstName <String>
-LastName <String>
-EmailAddress <String>
-Password <String>
-AdminStatus <String>
-IsAdmin
-Role <String>
-TenantName <String>
Examples
Example 1
New-NectarUserAccount -FirstName Turd -LastName Ferguson -Email tferguson@contoso.com -Password VeryStrongPassword -IsAdmin
Creates a new user called Turd Ferguson
Example 2
Import-Csv .\Users.csv | New-NectaUserAccount
Creates user accounts using a CSV file as input. CSV file must have the following headers: FirstName,LastName,Password,Email,AdminStatus (Use True/False for AdminStatus)
Parameters
-FirstName <String>
The user's first name
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-LastName <String>
The user's last name
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-EmailAddress <String>
The user's email address
| Parameter | Value |
|---|---|
| Required | true |
| Position | 3 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Password <String>
The password to assign to the new account
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-AdminStatus <String>
True if Admin, False if not. Used when importing many admin accounts via CSV
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-IsAdmin <SwitchParameter>
Include if user is to be an admin. If not present, then user will be read-only
| Parameter | Value |
|---|---|
| Required | false |
| Position | named |
| Required | false |
| Default Value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Role <String>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| 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 | 7 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?