Request deletion of a console user

Requests deletion of a console user. The request is asynchronous: it goes through the workspace’s configured “Delete users” approval policy (Settings > Quorums), exactly as deleting a user from the console does, and the user is removed only once that approval completes.

Track progress by polling GET /management/users; deletion is complete when the user is disabled.
Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin. Note: This endpoint is currently in beta and might be subject to changes.

DELETE

management

users

{id}

TypeScript

const response: Promise<FireblocksResponse<ConsoleUser>> = fireblocks.consoleUser.deleteConsoleUser(consoleUserApiDeleteConsoleUserRequest);

const options = {method: 'DELETE'};

fetch('https://api.fireblocks.io/v1/management/users/{id}', 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.fireblocks.io/v1/management/users/{id}",
  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.fireblocks.io/v1/management/users/{id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/management/users/{id}")

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "role": "OWNER",
  "enabled": true,
  "status": "PENDING_ACTIVATION",
  "userType": "API"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

string

required

The ID of the console user to delete

Query Parameters

force

boolean

default:false

Acknowledges the impact of removing this user and proceeds anyway. Overrides both USER_REFERENCED_IN_TAP and QUORUM_INTEGRITY, the same way the acknowledgement checkbox does in the console.

Response

Deletion request accepted. Returns the console user that will be removed once the workspace's configured approval completes.

string

The unique identifier of the user

firstName

string

The first name of the user

lastName

string

The last name of the user

string

The email address of the user

role

enum<string>

The role of the user

Available options:

OWNER,

ADMIN,

SIGNER,

COLLATERALS_SIGNER,

EDITOR,

APPROVER,

VIEWER,

NON_SIGNING_ADMIN,

AUDITOR,

NCW_ADMIN,

NCW_SIGNER,

SECURITY_ADMIN,

SECURITY_AUDITOR

enabled

boolean

Whether the user is enabled

status

enum<string>

The status of the user

Available options:

PENDING_ACTIVATION,

PENDING_DEVICE_PAIRING,

PENDING_DEVICE_SETUP,

READY

userType

enum<string>

The type of the user

Available options:

API,

CONSOLE

⌘I

TypeScript

const response: Promise<FireblocksResponse<ConsoleUser>> = fireblocks.consoleUser.deleteConsoleUser(consoleUserApiDeleteConsoleUserRequest);

const options = {method: 'DELETE'};

fetch('https://api.fireblocks.io/v1/management/users/{id}', 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.fireblocks.io/v1/management/users/{id}",
  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.fireblocks.io/v1/management/users/{id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/management/users/{id}")

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

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "role": "OWNER",
  "enabled": true,
  "status": "PENDING_ACTIVATION",
  "userType": "API"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Request deletion of a console user

Path Parameters

Query Parameters

Response