Src/Public/Remove-OpenAIUser.ps1
|
Function Remove-OpenAIUser { <# .NOTES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Module: PS-OpenAI Function: Remove-OpenAIUser (ROAIUser) Author: Martin Cooper (@mc1903) Date: 28-01-2023 GitHub Repo: https://github.com/mc1903/PS-OpenAI Version: 1.0.1 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .SYNOPSIS This function will remove a OpenAI User account .DESCRIPTION This function will remove a OpenAI User account .PARAMETER emailAddress (Required) (String) The email address of the OpenAI User account that is to be removed .PARAMETER apiKey (String) If the OpenAI API Key has been set using the environment variable $env:OpenAIApiKey, then providing it here is not necessary. .PARAMETER orgID (String) If the OpenAI Organisation ID has been set using the environment variable $env:OpenAIOrgID, then providing it here is not necessary. .PARAMETER jsonOut (Switch) If set the output is returned in Json format, otherwise a PSCustomObject is returned. .EXAMPLE Remove-OpenAIUser -emailAddress "user@example.com" #> [CmdletBinding()] [Alias("ROAIUser")] Param ( [Parameter( Position = 0, Mandatory = $true )] [ValidateNotNullOrEmpty()] [ValidatePattern("^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$")] [String] $emailAddress, [Parameter( Position = 1, Mandatory = $false )] [ValidateNotNullOrEmpty()] [String] $apiKey = $env:OpenAIApiKey, [Parameter( Position = 2, Mandatory = $false )] [ValidateNotNullOrEmpty()] [String] $orgID = $env:OpenAIOrgID, [Parameter( Position = 3, Mandatory = $false )] [Switch] $jsonOut ) If ([String]::IsNullOrEmpty($apiKey)) { Throw 'Please supply your OpenAI API Key as either the $env:OpenAIApiKey environment variable or by specifying the -apiKey parameter' } If ([String]::IsNullOrEmpty($orgID)) { Throw 'Please supply your OpenAI Organisation ID as either the $env:OpenAIOrgID environment variable or by specifying the -orgID parameter' } $userId = Find-UserId -emailAddress $emailAddress [uri]$url = "https://api.openai.com/v1/organizations/$orgID/users/$userID" Write-Verbose "APIKey is $(Hide-String -string $apiKey -percent 75)" $headers = @{ "Content-Type" = "application/json" "Authorization" = "Bearer $apiKey" "OpenAI-Organization" = "$orgID" } Try { $response = Invoke-RestMethod -Method Delete -Uri $url -Headers $headers } Catch { $response = $_ | ConvertFrom-Json } If ($jsonOut) { Return $response | ConvertTo-Json -Depth 10 } Else { Return $response } } |