New-R1FIDUser
New-R1FIDUser
SYNOPSIS
Creates a FID user.
SYNTAX
New-R1FIDUser [-username] <String> [-password] <SecureString> [-active] <Boolean> [[-firstName] <String>]
[[-lastName] <String>] [[-email] <String>] [-roles <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a FID user on the RadiantOne deployment.
Roles may be supplied when creating a user. The API schema marks roles as read-only, but the control panel sends them on create and the API accepts them. Use Set-R1FIDUserRole to change the roles of a user which already exists.
EXAMPLES
Example 1
New-R1FIDUser -username john_smith -password $securePassword -active $true
Creates an enabled user with the specified password.
Example 2
New-R1FIDUser -username john_smith -password $securePassword -active $true -firstName John -lastName Smith -email john@company.com
Creates an enabled user with full details.
PARAMETERS
-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
-active
Whether the user account is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
The email address of the user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-firstName
The first name of the user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-lastName
The last name of the user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-password
The password for the new user, as a SecureString.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-username
The username of the user to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-roles
The role names to associate with the new user.
The API schema marks roles as read-only, but the control panel sends it when creating a user and the API accepts it, so a user can be created with its roles in a single call. Use Set-R1FIDUserRole to change the roles of an existing user.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.