Public/Get-JiraUser.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
function Get-JiraUser {
    <#
    .Synopsis
       Returns a user from Jira
    .DESCRIPTION
       This function returns information regarding a specified user from Jira.
    .EXAMPLE
       Get-JiraUser -UserName user1 -Credential $cred
       Returns information about the user user1
    .EXAMPLE
       Get-ADUser -filter "Name -like 'John*Smith'" | Select-Object -ExpandProperty samAccountName | Get-JiraUser -Credential $cred
       This example searches Active Directory for the username of John W. Smith, John H. Smith,
       and any other John Smiths, then obtains their JIRA user accounts.
    .INPUTS
       [String[]] Username
       [PSCredential] Credentials to use to connect to Jira
    .OUTPUTS
       [JiraPS.User]
    #>

    [CmdletBinding(DefaultParameterSetName = 'ByUserName')]
    param(
        # Username, name, or e-mail address of the user. Any of these should
        # return search results from Jira.
        [Parameter(
            Position = 0,
            Mandatory = $true,
            ParameterSetName = 'ByUserName'
        )]
        [ValidateNotNullOrEmpty()]
        [Alias('User', 'Name')]
        [String[]] $UserName,

        # User Object of the user.
        [Parameter(
            Position = 0,
            Mandatory = $true,
            ParameterSetName = 'ByInputObject'
        )]
        [Object[]] $InputObject,

        # Include inactive users in the search
        [Switch] $IncludeInactive,

        # Credentials to use to connect to JIRA.
        # If not specified, this function will use anonymous access.
        [Parameter(Mandatory = $false)]
        [System.Management.Automation.PSCredential] $Credential
    )

    begin {
        Write-Debug "[Get-JiraUser] Reading server from config file"
        $server = Get-JiraConfigServer -ConfigFile $ConfigFile -ErrorAction Stop

        Write-Debug "[Get-JiraUser] ParameterSetName=$($PSCmdlet.ParameterSetName)"

        Write-Debug "[Get-JiraUser] Building URI for REST call"
        $userSearchUrl = "$server/rest/api/latest/user/search?username={0}"
        if ($IncludeInactive) {
            $userSearchUrl = "$userSearchUrl&includeInactive=true"
        }

        # $userGetUrl = "$server/rest/api/latest/user?username={0}&expand=groups"
    }

    process {
        if ($PSCmdlet.ParameterSetName -eq 'ByUserName') {
            foreach ($u in $UserName) {
                Write-Debug "[Get-JiraUser] Processing user [$u]"
                $thisSearchUrl = $userSearchUrl -f $u

                Write-Debug "[Get-JiraUser] Preparing for blastoff!"
                $rawResult = Invoke-JiraMethod -Method Get -URI $thisSearchUrl -Credential $Credential

                if ($rawResult) {
                    Write-Debug "[Get-JiraUser] Processing raw results from JIRA"
                    foreach ($r in $rawResult) {
                        Write-Debug "[Get-JiraUser] Re-obtaining user information for user [$r]"
                        $url = '{0}&expand=groups' -f $r.self
                        Write-Debug "[Get-JiraUser] Preparing for blastoff!"
                        $thisUserResult = Invoke-JiraMethod -Method Get -URI $url -Credential $Credential

                        if ($thisUserResult) {
                            Write-Debug "[Get-JiraUser] Converting result to JiraPS.User object"
                            $thisUserObject = ConvertTo-JiraUser -InputObject $thisUserResult
                            Write-Output $thisUserObject
                        }
                        else {
                            Write-Debug "[Get-JiraUser] User [$r] could not be found in JIRA."
                        }
                    }
                }
                else {
                    Write-Debug "[Get-JiraUser] JIRA returned no results."
                    Write-Verbose "JIRA returned no results for user [$u]."
                }
            }
        }
        else {
            foreach ($i in $InputObject) {
                Write-Debug "[Get-JiraUser] Processing InputObject [$i]"
                if ((Get-Member -InputObject $i).TypeName -eq 'JiraPS.User') {
                    Write-Debug "[Get-JiraUser] User parameter is a JiraPS.User object"
                    $thisUserName = $i.Name
                }
                else {
                    $thisUserName = $i.ToString()
                    Write-Debug "[Get-JiraUser] Username is assumed to be [$thisUserName] via ToString()"
                }

                Write-Debug "[Get-JiraUser] Invoking myself with the UserName parameter set to search for user [$thisUserName]"
                $userObj = Get-JiraUser -UserName $thisUserName -Credential $Credential
                Write-Debug "[Get-JiraUser] Returned from invoking myself; outputting results"
                Write-Output $userObj
            }
        }
    }

    end {
        Write-Debug "[Get-JiraUser] Complete"
    }
}