Public/Remove-MerakiOrganizationAdmin.ps1
|
function Remove-MerakiOrganizationAdmin { <# .SYNOPSIS Removes an existing administrator from a Meraki organization using the Meraki Dashboard API. .DESCRIPTION The Remove-MerakiOrganizationAdmin function allows you to remove an existing administrator from a specified Meraki organization by providing the authentication token and administrator ID. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER AdminId The ID of the administrator to be removed. .EXAMPLE Remove-MerakiOrganizationAdmin -AuthToken "your-api-token" -AdminId "1234567890" This example removes the administrator with ID "1234567890" from the organization. .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the configuration is successful, otherwise, it displays an error message. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$true)] [string]$AdminId, [parameter(Mandatory=$false)] [string]$OrganizationID = (Get-OrgID -AuthToken $AuthToken) ) If($OrganizationID -eq "Multiple organizations found. Please specify an organization ID.") { Return "Multiple organizations found. Please specify an organization ID." } else { try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken "content-type" = "application/json; charset=utf-8" } $url = "https://api.meraki.com/api/v1/organizations/$OrganizationId/admins/$AdminId" $response = Invoke-RestMethod -Method Delete -Uri $url -Header $header -UserAgent "MerakiPowerShellModule/1.0.2 DocNougat" return $response } catch { Write-Debug $_ Throw $_ } } } |