BitTitan.Runbooks.GSuite

0.1.7

Functions/Remove-GSuiteGroupMember.ps1

<#
.SYNOPSIS
    This function removes a member from a group in GSuite.
#>
function Remove-GSuiteGroupMember {
    [CmdletBinding(PositionalBinding=$false)]
    [OutputType([Bool])]
    param (
        # The primary email address of the group.
        [Parameter(Mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [String]$groupPrimaryEmailAddress,

        # The primary email address of the member.
        [Parameter(Mandatory=$true)]
        [ValidateNotNullOrEmpty()]
        [String]$memberPrimaryEmailAddress
    )

    # Validate that the 'connection' has been established
    if (!$Global:GSuiteAccessTokensHashTable) {
        throw "You must call the Connect-GSuiteAdminAccount cmdlet before calling any other GSuite cmdlets."
    }

    # Validate that the group access token exists in the hash table
    if ([String]::IsNullOrWhiteSpace($Global:GSuiteAccessTokensHashTable.Group)) {
        throw "Group access token is required to call Remove-GSuiteGroupMember."
    }

    # Prepare REST call parameters
    $invokeRestMethodParams = @{
        Uri     = "https://www.googleapis.com/admin/directory/v1/groups/$($groupPrimaryEmailAddress)/members/$($memberPrimaryEmailAddress)"
        Method  = "DELETE"
        Headers = @{
            Accept        = "application/json"
            Authorization = "Bearer $($Global:GSuiteAccessTokensHashTable.Group)"
        }
    }

    # Invoke the REST call
    $response = Invoke-RestMethod @invokeRestMethodParams

    # If the removal is successful, $response will be an empty string
    if ("" -eq $response) {
        return $true
    }
    else {
        return $false
    }
}