Public/Remove-LMAPIToken.ps1
|
<# .SYNOPSIS Removes an API token from Logic Monitor. .DESCRIPTION The Remove-LMAPIToken function is used to remove an API token from Logic Monitor. It supports removing the token by specifying either the token's ID, the user's ID and token's ID, or the user's name and token's ID. .PARAMETER UserId The ID of the user associated with the API token. This parameter is mandatory when using the 'Id' parameter set. .PARAMETER UserName The name of the user associated with the API token. This parameter is mandatory when using the 'Name' parameter set. .PARAMETER AccessId The access ID of the API token. This parameter is mandatory when using the 'AccessId' parameter set. .PARAMETER APITokenId The ID of the API token. This parameter is mandatory when using the 'Id' or 'Name' parameter set. .EXAMPLE Remove-LMAPIToken -UserId 1234 -APITokenId 5678 Removes the API token with ID 5678 associated with the user with ID 1234. .EXAMPLE Remove-LMAPIToken -UserName "john.doe" -APITokenId 5678 Removes the API token with ID 5678 associated with the user with name "john.doe". .EXAMPLE Remove-LMAPIToken -AccessId "abcd1234" Removes the API token with the specified access ID. .INPUTS You can pipe api token objects to this function. .OUTPUTS A custom object with the following properties: - Id: The ID of the removed API token. - Message: A message indicating the success of the removal operation. .NOTES This function requires a valid API authentication. Make sure to log in using Connect-LMAccount before running this command. #> Function Remove-LMAPIToken { [CmdletBinding(DefaultParameterSetName = 'Id', SupportsShouldProcess, ConfirmImpact = 'High')] Param ( [Parameter(Mandatory, ParameterSetName = 'Id')] [Int]$UserId, [Parameter(Mandatory, ParameterSetName = 'Name')] [String]$UserName, [Parameter(Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'AccessId')] [String]$AccessId, [Parameter(Mandatory, ParameterSetName = 'Id')] [Parameter(Mandatory, ParameterSetName = 'Name')] [Int]$APITokenId ) Begin {} Process { #Check if we are logged in and have valid api creds If ($Script:LMAuth.Valid) { #Lookup UserName Id if supplying username If ($UserName) { $LookupResult = (Get-LMUser -Name $UserName).Id If (Test-LookupResult -Result $LookupResult -LookupString $UserName) { return } $UserId = $LookupResult } If ($AccessId) { $LookupResult = (Get-LMAPIToken -AccessId $AccessId) If (Test-LookupResult -Result $LookupResult -LookupString $AccessId) { return } $UserId = $LookupResult.adminId $APITokenId = $LookupResult.id } #Build header and uri $ResourcePath = "/setting/admins/$UserId/apitokens/$APITokenId" If ($PSItem) { $Message = "Id: $APITokenId | AccessId: $($PSItem.accessId)| AdminName:$($PSItem.adminName)" } Else { $Message = "Id: $APITokenId" } Try { If ($PSCmdlet.ShouldProcess($Message, "Remove API Token")) { $Headers = New-LMHeader -Auth $Script:LMAuth -Method "DELETE" -ResourcePath $ResourcePath $Uri = "https://$($Script:LMAuth.Portal).logicmonitor.com/santaba/rest" + $ResourcePath Resolve-LMDebugInfo -Url $Uri -Headers $Headers[0] -Command $MyInvocation #Issue request $Response = Invoke-RestMethod -Uri $Uri -Method "DELETE" -Headers $Headers[0] -WebSession $Headers[1] $Result = [PSCustomObject]@{ Id = $APITokenId Message = "Successfully removed ($Message)" } Return $Result } } Catch [Exception] { $Proceed = Resolve-LMException -LMException $PSItem If (!$Proceed) { Return } } } Else { Write-Error "Please ensure you are logged in before running any commands, use Connect-LMAccount to login and try again." } } End {} } |