Delete-GreenRadiusYubikeyToken.ps1
|
function Delete-GreenRadiusYubikeyToken { <# .SYNOPSIS Deletes a YubiKey OTP token in GreenRADIUS. .DESCRIPTION Utilizes the GreenRADIUS API to delete a YubiKey OTP token into GreenRADIUS. Reqires Connect-GreenRadiusApi to have been called at some point earlier in the PowerShell session. .OUTPUTS $true if import was successful, $false if not. If not successful, an explanation of the failure will also be passed to Write-Error. .PARAMETER PublicIdentity The public ID of the OTP, which presents itself in actual OTP codes as the first twelve characters, which do not change. .PARAMETER Force Deletes the token even if the token is currently assigned to a user. If not present, or set to $false, then attempting to delete an assigned token will result in a failure message. .PARAMETER RawRequest Variable name, without the dollar sign, in which to store the raw request which was created and sent to the API. This does not need to be a pre-existing variable. Mostly used for debugging this function. .PARAMETER RawResponse Variable name, without the dollar sign, in which to store the raw response from the API. This does not need to be a pre-existing variable. Mostly used for debugging this function. .NOTES Version 2026.02.09.1446 #> <# LICENSE Copyright (c) 2026 Derek Howard and the City of Eureka, California Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, and/or distribute copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software, and the original author shall be credited as having created the original work. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> [CmdletBinding()] param ( [Parameter(Mandatory=$true)] [string]$PublicIdentity, [switch]$Force, [string]$RawRequest, [string]$RawResponse ) if (-not $global:GreenRadiusApiSession) { Write-Error "You forgot to run Connect-GreenRadiusApi!" return $false; } $Body = @{ deletealways = $Force yubikeys = @( @{ publicname = $PublicIdentity } ) } $Params = @{ Uri = "https://$($global:GreenRadiusApiSession.HostName)/gras-api/v2/mgmt/delete_token/yubikey" Method = "Delete" Credential = $global:GreenRadiusApiSession.Credential Body = ($Body | ConvertTo-Json -Depth 5) ContentType = "application/json" } if ($RawRequest) { Set-Variable -Name $RawRequest -Value $apiResult -Scope 1 } $apiResult = Invoke-RestMethod @Params if ($apiResult.GetType().Name -eq "String") { #This only seems necessary for the /tokenassignment api (used in Get-GreenRadiusTokenAssignments) #and even then only when no search parameters are specified, but here we go anyway $apiResult = $apiResult | ConvertFrom-Json -AsHashTable } if ($RawResponse) { Set-Variable -Name $RawResponse -Value $apiResult -Scope 1 } if ($apiResult.records_deleted.Count -gt 0) { return $true } else { if ($apiResult.records_skipped.Count -gt 0) { Write-Error $apiResult.records_skipped.description } elseif ($apiResult.records_invalid.Count -gt 0) { Write-Error $apiResult.records_invalid.description } return $false } } |