On this page

    New-JiraUser

    SYNOPSIS

    Creates a new user in JIRA

    SYNTAX

    New-JiraUser [-UserName] <String> [-EmailAddress] <String> [[-DisplayName] <String>] [[-Notify] <Boolean>]
 [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

    DESCRIPTION

    This function creates a new user in JIRA.

    By default, the new user will be notified via e-mail.

    The new user’s password is also randomly generated.

    EXAMPLES

    EXAMPLE 1

    New-JiraUser -UserName "testUser" -EmailAddress "[email protected]"

    This example creates a new JIRA user named testUser, and sends a notification e-mail. The user’s DisplayName will be set to “testUser” since it is not specified.

    EXAMPLE 2

    New-JiraUser -UserName "testUser2" -EmailAddress "[email protected]" -DisplayName "Test User 2"

    This example illustrates setting a user’s display name during user creation.

    PARAMETERS

    -UserName

    Name of user.

    Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -EmailAddress

    E-mail address of the user.

    Type: String
Parameter Sets: (All)
Aliases: Email

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -DisplayName

    Display name of the user.

    Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Notify

    Notify the user by e-mail

    Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: True
Accept pipeline input: False
Accept wildcard characters: False

    -Credential

    Credentials to use to connect to JIRA.
    If not specified, this function will use anonymous access.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
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

    -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

    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 (http://go.microsoft.com/fwlink/?LinkID=113216).

    INPUTS

    OUTPUTS

    [JiraPS.User]

    NOTES

    This function requires either the -Credential parameter to be passed or a persistent JIRA session. See New-JiraSession for more details. If neither are supplied, this function will run with anonymous access to JIRA.

    Get-JiraUser

    Remove-JiraUser