New-JiraUser

NAME 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.





PARAMETERS

-UserName <String>

Name of user.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EmailAddress <String>

E-mail address of the user.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DisplayName <String>

Display name of the user.



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Notify <Boolean>

Notify the user by e-mail



Required? false

Position? 4

Default value True

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Credentials to use to connect to JIRA.

If not specified, this function will use anonymous access.



Required? false

Position? 5

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/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.



-------------------------- EXAMPLE 1 --------------------------



New-JiraUser -UserName "testUser" -EmailAddress "testUser@example.com"



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 "testUser2@example.com" -DisplayName "Test User 2"



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



RELATED LINKS

Online Version: https://atlassianps.org/docs/JiraPS/com ... -JiraUser/

Get-JiraUser

Remove-JiraUser