Delete an existing user group

delete /platform/iam/v1/user-group/{group_id}

Delete an existing user group. Note: upon deletion of a user group, its nested groups are not deleted; the relationships are simply removed.

Path parameters

group_id String required

Full user group id

Example: 7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123

CLIENT REQUEST

          curl -X 'DELETE'

        -H
        'Accept: application/json'
      
      'https://api-cortex.paloaltonetworks.com/platform/iam/v1/user-group/{group_id}'

import http.client

conn = http.client.HTTPSConnection("api-")

conn.request("DELETE", "%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123");

xhr.send(data);

HttpResponse<String> response = Unirest.delete("https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123")
  .asString();

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://api-/%7Bfqdn%7D/platform/iam/v1/user-group/7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);

Responses

User Group deleted successfully

Body

application/json

dataobject

messagestringrequired

Success message indicating the user group was deleted

RESPONSE
{
  "data": {
    "message": "user group with group id 7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123 deleted successfully"
  }
}

Bad request for user group delete call

Body

application/json

dataobject

err_msgstringrequired

Error message describing the issue

metadataobject

err_extrastringrequired

Additional error details

err_codeintegerrequired

HTTP error code

RESPONSE
{
  "data": {
    "err_msg": "The request contains invalid or missing parameters.",
    "metadata": {
      "err_extra": "Could not find group for ['7f8a9b2c-4d5e-4f6a-8b9c-1d2e3f4a5b6c_123'] in tenant: tenant_name",
      "err_code": 400
    }
  }
}

Unauthorized access

Body

application/json

RESPONSE
{
  "reply": {
    "err_code": 401,
    "err_msg": "Public API request unauthorized",
    "err_extra": null
  }
}

Unauthorized access due to lack of sufficient permissions

Body

application/json

replyobject

err_msgstringrequired

err_extrastring

err_codeinteger

metadataobjectrequired

RESPONSE
{
  "reply": {
    "err_code": 403,
    "err_msg": "Forbidden. Access was denied to this resource.",
    "err_extra": "Insufficient permissions for api key",
    "metadata": {}
  }
}

Internal server error. A unified status for API communication type errors.