CUT-4228: Get-JCAdmin Function

[gweinjc]

Issues

• CUT-4228 - Get-JCAdmin Function

What does this solve?

This new function allows for administrators to query the administrators in their organization. MTP/MSP tenants will have the ability to query all of their organizations or individually.

Is there anything particularly tricky?

Since the endpoint used to query admins does not have a searchFilter option, we had to manually create a filter using a foreach loop on the inputted params.

# Create a FilterScript scriptblock for use in Where-Object to filter the results based on the params used
$filterScriptArray = @()
foreach ($param in $PSBoundParameters.GetEnumerator()) {
    if ([System.Management.Automation.PSCmdlet]::CommonParameters -contains $param.key) {
        continue
    }
    if ($param.value -is [Boolean]) {
        $filterScriptArray += "`$_.$($param.key) -eq `$$($param.value)"
        continue
    }
    if ($param.value -is [String]) {
        $filterScriptArray += "`$_.$($param.key) -like '$($param.value)'"
        continue
    }
}
$filterScriptString = $filterScriptArray -join " -and "
$filterScript = [Scriptblock]::Create($filterScriptString)

The $filterScript is then used in a Where-Object -FilterScript $FilterScript to perform the actual filtering

How should this be tested?

• Pester test suites have been created for both MTP/MSP tenants as well as regular tenants.

Non-MTP/MSP Tenant

# Get all admins
$Admins = Get-JCAdmin
$Admins | Should -Not -BeNullOrEmpty

# Get a specific administrator by email address'
$Admins = Get-JCAdmin -email 'solutions-architecture+pestermtp@jumpcloud.com'
$Admins | Should -Not -BeNullOrEmpty

# Get a specific administrator by email address with wildcard
$Admins = Get-JCAdmin -email 'solutions-architecture*'
$Admins | Should -Not -BeNullOrEmpty

# Get administrators by enableMultifactor
$Admins = Get-JCAdmin -enableMultifactor $true
$Admins | Should -Not -BeNullOrEmpty

# Get administrators by totpEnrolled
$Admins = Get-JCAdmin -totpEnrolled $true
$Admins | Should -Not -BeNullOrEmpty

# Get administrators by roleName
$Admins = Get-JCAdmin -roleName 'Administrator With Billing'
$Admins | Should -Not -BeNullOrEmpty

# Get administrators by email, enableMultifactor, totpEnrolled, roleName
$Admins = Get-JCAdmin -email 'solutions-architecture*' -enableMultifactor $true -totpEnrolled $true -roleName 'Administrator With Billing'
$Admins | Should -Not -BeNullOrEmpty

MTP/MSP Tenants

• Same as above, however you can filter by a specific organization ID

# Get all organizations
$orgs = Get-JCOrganization

# Get all admins
$Admins = Get-JCAdmin
$Admins | Should -Not -BeNullOrEmpty

# Get administrators by email, enableMultifactor, totpEnrolled, roleName and organization
$Admins = Get-JCAdmin -email 'solutions-architecture*' -enableMultifactor $true -totpEnrolled $true -roleName 'Administrator With Billing' -organization $orgs[0].OrgID
$Admins | Should -Not -BeNullOrEmpty

[jworkmanjc]

This is really great, two items I believe we should change but otherwise perfect execution here.

There's no way to get around the filtering, that's okay.

Let me know what you think about those two comments on the params?

[kmaranionjc]

Great work! Tests worked on my end and code looks good.