Skip to main content
DELETE
/
api
/
disks
/
{id}
/
users
/
{userType}
Remove user from disk
curl --request DELETE \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType} \
  --header 'Authorization: <api-key>'
import requests

url = "https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}', 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://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$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://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}"

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

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id}/users/{userType}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "message": "<string>"
  }
}
{
"success": false,
"error": "Invalid request parameters"
}
{
"success": false,
"error": "Invalid request parameters"
}
{
"success": false,
"error": "Invalid request parameters"
}

Authorizations

Authorization
string
header
required

API key

Path Parameters

id
string
required

Disk ID (format dsk-{16 hex chars})

Pattern: ^dsk-[0-9a-f]{16}$
Example:

"dsk-0123456789abcdef"

userType
enum<string>
required

The type of user authentication

Available options:
token,
awssts

Query Parameters

identifier
string

Identifier of the user to remove, as returned in the creation or list response. For awssts users, this is the IAM ARN.

principal
string

Use identifier instead.

Response

User removed successfully

success
boolean
required
Example:

true

data
object
required