Public/Remove-JuribaEvergreenSelfServicePortal.ps1
|
function Remove-JuribaEvergreenSelfServicePortal { [alias("Remove-DwEvergreenSelfServicePortal")] <# .SYNOPSIS Deletes a self service portal. .DESCRIPTION Deletes a self service portal using Dashworks API v1. .PARAMETER Instance Dashworks instance. For example, https://myinstance.dashworks.app:8443 .PARAMETER APIKey Dashworks API Key. .PARAMETER ServiceId ServiceID for the self service to be deleted. .OUTPUTS The self service portal has been deleted .EXAMPLE PS> Remove-JuribaEvergreenSelfServicePortal @dwparams -ServiceId 1 #> [CmdletBinding(SupportsShouldProcess)] [OutputType([string])] param( [Parameter(Mandatory = $false)] [string]$Instance, [Parameter(Mandatory = $false)] [string]$APIKey, [Parameter(Mandatory = $true)] [int]$ServiceId ) if ((Get-Variable 'dwConnection' -Scope 'Global' -ErrorAction 'Ignore') -and !$APIKey -and !$Instance) { $APIKey = ConvertFrom-SecureString -SecureString $dwConnection.secureAPIKey -AsPlainText $Instance = $dwConnection.instance } if ($APIKey -and $Instance) { $body = @{ serviceIds = @($ServiceId) actionRequestType = "Delete" } | ConvertTo-Json $uri = "{0}/apiv1/admin/selfservices" -f $Instance $headers = @{'x-api-key' = $APIKey } try { if ($PSCmdlet.ShouldProcess($ServiceId)) { $result = Invoke-WebRequest -Uri $uri -Method DELETE -Body $body -Headers $headers -ContentType 'application/json' if($result.StatusCode -eq 200) { return "The self service portal has been deleted" } } } catch { Write-Error $_ } } else { Write-Error "No connection found. Please ensure `$APIKey and `$Instance is provided or connect using Connect-Juriba before proceeding." } } |