On this page

    Set-JiraUser

    SYNOPSIS

    Modifies user properties in JIRA

    SYNTAX

    ByNamedParameters (Default)

    Set-JiraUser [-User] <Object[]> [-DisplayName <String>] [-EmailAddress <String>] [[-Active] <Boolean>]
 [-Credential <PSCredential>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

    ByHashtable

    Set-JiraUser [-User] <Object[]> [-Property] <Hashtable> [-Credential <PSCredential>] [-PassThru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

    DESCRIPTION

    This function modifies user properties in JIRA, allowing you to change a user’s e-mail address, display name, and any other properties supported by JIRA’s API.

    EXAMPLES

    EXAMPLE 1

    Set-JiraUser -User user1 -EmailAddress [email protected]

    Modifies user1’s e-mail address to a new value. The original value is overridden.

    EXAMPLE 2

    Set-JiraUser -User user2 -Property @{emailAddress='[email protected]';displayName='User 2'}

    This example modifies a user’s properties using a hashtable. This allows updating properties that are not exposed as parameters to this function.

    PARAMETERS

    -User

    Username or user object obtained from Get-JiraUser.

    Type: Object[]
Parameter Sets: (All)
Aliases: UserName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

    -DisplayName

    Display name to set.

    Type: String
Parameter Sets: ByNamedParameters
Aliases:

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

    -EmailAddress

    E-mail address to set.

    Type: String
Parameter Sets: ByNamedParameters
Aliases:

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

    -Active

    Sets user to active or inactive.

    Type: Boolean
Parameter Sets: ByNamedParameters
Aliases:

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

    -Property

    Hashtable (dictionary) of additional information to set.

    Property names defined in the hashtable are strictly case-sensitive and must match the exact format defined in the JIRA API schema, which typically uses camel case. For example, “name” and “displayName” will work correctly when passed in the hashtable but “Name” and “DisplayName” do not.

    Type: Hashtable
Parameter Sets: ByHashtable
Aliases:

Required: True
Position: 2
Default value: None
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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -PassThru

    Whether output should be provided after invoking this function.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

    [JiraPS.User]

    OUTPUTS

    [JiraPS.User]

    If the -PassThru parameter is provided, this function will provide a reference to the JIRA user modified. Otherwise, this function does not provide output.

    NOTES

    The -Active parameter is supported only in Jira Server version 8.3.0 and above.

    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.

    New-JiraUser

    Get-JiraUser