UofIQualys

1.8.1

functions/public/Set-QualysUser.ps1

<#
.Synopsis
    Edits a user in Qualys
.DESCRIPTION
    Edits a user in Qualys
.PARAMETER Credential
    This API call only supports basic HTTP authentication. You must provide your credentials separately for this function.
.PARAMETER Login
    Specifies the Qualys user login of the user account you wish to edit.
.PARAMETER ExternalID
    Set a custom External ID (required for SSO)
.PARAMETER AssetGroups
    Specifies the asset groups assigned to the user, when theuser role is Scanner, Reader or Contact.
.PARAMETER FirstName
    Specifies the user's first name.
.PARAMETER LastName
    Specifies the user's last name
.PARAMETER Title
    Specifies the user's job title.
.PARAMETER Email
    Specifies the user's email address.
.PARAMETER Phone
    Specifies the user’s phone number.
.PARAMETER Address
    Specifies the user’s address.
.PARAMETER City
    Specifies the user’s city.
.PARAMETER Country
    Specifies the user’s country.
.PARAMETER State
    Specifies the user’s state.
.EXAMPLE
    Set-QualysUser -Credential $Credential -Login testuser -AssetGroups TestGroup
.EXAMPLE
    $SetUserSplat = @{
        Login = testuser
        Phone = '555-555-555'
        Address = 'University of Illinois'
        city = 'Urbana'
        country = 'United States of America'
        state = 'Illinois'
        FirstName = 'Jane'
        LastName = 'Doe'
        Title = 'Test User'
        email = 'JaneDoe@test.null'
        Credential = $Credential
    }
    Set-QualysUser @SetUserSplat
#>
function Set-QualysUser{
    [CmdletBinding(SupportsShouldProcess)]
    [Alias()]
    param (
        [Parameter(Mandatory=$true)]
        [System.Management.Automation.PSCredential]$Credential,
        [Parameter(Mandatory=$true)]
        [String]$Login,
        [String[]]$AssetGroups,
        [Alias('first_name')]
        [String]$FirstName,
        [Alias('last_name')]
        [String]$LastName,
        [String]$Title,
        [String]$Email,
        [String]$Phone,
        [Alias('address1')]
        [String]$Address,
        [String]$City,
        [String]$Country,
        [String]$State,
        [Alias('external_id')]
        [String]$ExternalID

    )

    process{

        if ($PSCmdlet.ShouldProcess("$($Login)")){

            $RestSplat = @{
                Method = 'POST'
                RelativeURI = 'msp/user.php'
                Credential = $Credential
                Body = @{
                    action = 'edit'
                }
            }

            #Takes any parameter that's set, except excluded ones, and adds one of the same name (or alias name if present) to the API body
            [String[]]$Exclusions = ('Credential', 'AssetGroups', 'Verbose')
            $PSBoundParameters.Keys | Where-Object -FilterScript {($_ -notin $Exclusions) -and $_} | ForEach-Object -Process {
                if($MyInvocation.MyCommand.Parameters[$_].Aliases[0]){
                    [String]$APIKeyNames = $MyInvocation.MyCommand.Parameters[$_].Aliases[0]
                    $RestSplat.Body.$APIKeyNames = $PSBoundParameters[$_]
                }
                else {
                    $RestSplat.Body.$_ = $PSBoundParameters[$_]
                }
            }

            If($AssetGroups){
                $RestSplat.Body['asset_groups'] = (($AssetGroups).Trim() -join ",")
            }

            $Response = Invoke-QualysRestCall @RestSplat
            if ($Response.USER_OUTPUT.RETURN.MESSAGE) {
                Write-Verbose -Message $Response.USER_OUTPUT.RETURN.MESSAGE
            }
            else {
                $Response.USER_OUTPUT.RETURN.MESSAGE
            }
        }
    }
}