Delete Role

curl --request DELETE \
  --url https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

response = requests.delete(url)

print(response.text)

const options = {method: 'DELETE'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}",
  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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

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

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

DELETE

app

organizations

{organizationId}

roles

{roleId}

Delete Role

curl --request DELETE \
  --url https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}

import requests

url = "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

response = requests.delete(url)

print(response.text)

const options = {method: 'DELETE'};

fetch('https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}",
  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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/app/v1/organizations/{organizationId}/roles/{roleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

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

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

Path Parameters

organizationId

string

required

Organization ID

roleId

string

required

Role ID

Response

{
  "message": "Role successfully deleted",
  "id": "role123"
}

Deleting a role will remove it from all users who have it assigned. Consider the impact on user permissions before deleting.

Error Responses

Role Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Role not found"
  }
}

Role In Use

{
  "error": {
    "code": "ROLE_IN_USE_BY_USERS",
    "message": "Cannot delete a role that is used in users user123, user456"
  }
}

Code Examples

curl -X DELETE "https://api.metabind.ai/app/v1/organizations/org123/roles/role123" \
  -H "Authorization: Bearer YOUR_JWT"

const response = await fetch(
  'https://api.metabind.ai/app/v1/organizations/org123/roles/role123',
  {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer YOUR_JWT'
    }
  }
);

const result = await response.json();
console.log(result.message);

var request = URLRequest(url: URL(string: "https://api.metabind.ai/app/v1/organizations/org123/roles/role123")!)
request.httpMethod = "DELETE"
request.setValue("Bearer YOUR_JWT", forHTTPHeaderField: "Authorization")

let (data, _) = try await URLSession.shared.data(for: request)

val response = client.delete("https://api.metabind.ai/app/v1/organizations/org123/roles/role123") {
    header("Authorization", "Bearer YOUR_JWT")
}

println("Deleted role")

Update Role List Role Users

​Path Parameters

​Response

​Error Responses

​Role Not Found

​Role In Use

​Code Examples

Path Parameters

Response

Error Responses

Role Not Found

Role In Use

Code Examples