Deactivate User

curl --request PUT \
  --url https://api.dfns.io/auth/users/{userId}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '{
  "force": false
}'

import requests

url = "https://api.dfns.io/auth/users/{userId}/deactivate"

payload = { "force": False }
headers = {
    "Authorization": "Bearer <token>",
    "X-DFNS-USERACTION": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'X-DFNS-USERACTION': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({force: false})
};

fetch('https://api.dfns.io/auth/users/{userId}/deactivate', 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.dfns.io/auth/users/{userId}/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'force' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-DFNS-USERACTION: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dfns.io/auth/users/{userId}/deactivate"

	payload := strings.NewReader("{\n  \"force\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-DFNS-USERACTION", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.dfns.io/auth/users/{userId}/deactivate")
  .header("Authorization", "Bearer <token>")
  .header("X-DFNS-USERACTION", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"force\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/auth/users/{userId}/deactivate")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-DFNS-USERACTION"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"force\": false\n}"

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

{
  "username": "<string>",
  "name": "<string>",
  "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
  "kind": "TenantUser",
  "credentialUuid": "<string>",
  "isActive": true,
  "isServiceAccount": true,
  "isRegistered": true,
  "isSSORequired": true,
  "permissionAssignments": [
    {
      "permissionName": "<string>",
      "permissionId": "pm-37vj4-jkr4l-lc9945spfftkne57",
      "assignmentId": "as-1vcmc-qrek0-6b4vii9pln60907e",
      "operations": [
        "<string>"
      ]
    }
  ],
  "credentialId": "<string>",
  "orgId": "or-30tnh-itmjs-s235s5ontr3r23h2",
  "tenantId": "acct-24hka-dhili-9hgvdlvr1ohpibp4",
  "permissions": [
    "<string>"
  ]
}

PUT

auth

users

{userId}

deactivate

Deactivate User

curl --request PUT \
  --url https://api.dfns.io/auth/users/{userId}/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '{
  "force": false
}'

import requests

url = "https://api.dfns.io/auth/users/{userId}/deactivate"

payload = { "force": False }
headers = {
    "Authorization": "Bearer <token>",
    "X-DFNS-USERACTION": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer <token>',
    'X-DFNS-USERACTION': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({force: false})
};

fetch('https://api.dfns.io/auth/users/{userId}/deactivate', 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.dfns.io/auth/users/{userId}/deactivate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'force' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-DFNS-USERACTION: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dfns.io/auth/users/{userId}/deactivate"

	payload := strings.NewReader("{\n  \"force\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-DFNS-USERACTION", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.dfns.io/auth/users/{userId}/deactivate")
  .header("Authorization", "Bearer <token>")
  .header("X-DFNS-USERACTION", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"force\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/auth/users/{userId}/deactivate")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-DFNS-USERACTION"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"force\": false\n}"

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

{
  "username": "<string>",
  "name": "<string>",
  "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
  "kind": "TenantUser",
  "credentialUuid": "<string>",
  "isActive": true,
  "isServiceAccount": true,
  "isRegistered": true,
  "isSSORequired": true,
  "permissionAssignments": [
    {
      "permissionName": "<string>",
      "permissionId": "pm-37vj4-jkr4l-lc9945spfftkne57",
      "assignmentId": "as-1vcmc-qrek0-6b4vii9pln60907e",
      "operations": [
        "<string>"
      ]
    }
  ],
  "credentialId": "<string>",
  "orgId": "or-30tnh-itmjs-s235s5ontr3r23h2",
  "tenantId": "acct-24hka-dhili-9hgvdlvr1ohpibp4",
  "permissions": [
    "<string>"
  ]
}

Authentication

✅ Tenant User (TenantUser)
✅ Organization User (CustomerEmployee)
❌ End User (EndUser)
❌ Personal Access Token not allowed
✅ Service Account

Required Permissions

Auth:Users:Deactivate: Always required.

Authorizations

Authorization

string

header

required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

X-DFNS-USERACTION

string

header

required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Path Parameters

userId

string

required

User id.

Required string length: 1 - 64

Body

application/json

force

boolean

default:false

If true, deactivates the user even when they are the last admin, a policy names them as an approver, or a policy needs them to reach a quorum, so a compromised last admin can be cut off. The org can be left with no active admin, and with policies that can no longer reach their quorum.

Response

200 - application/json

Success

username

string

required

Username/identifier of the user (any unique string accepted, e.g. your internal user ID or email).

name

string

required

Display name of the user.

userId

string

required

User id.

Required string length: 1 - 64

Pattern: ^us-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"us-6b58p-r53sr-rlrd3l5cj3uc4ome"

kind

enum<string>

required

User kind.

Available options:

TenantUser,

CustomerEmployee,

EndUser

credentialUuid

string

required

UUID of the user's primary credential.

isActive

boolean

required

Whether the user is active.

isServiceAccount

boolean

required

Whether the user is a service account.

isRegistered

boolean

required

Whether the user has completed registration.

isSSORequired

boolean

required

Whether the user must authenticate via SSO.

permissionAssignments

object[]

required

Permissions (roles) assigned to the user.

Show child attributes

credentialId

string

The credential id used for user-action signing, derived as base64url(sha256(publicKey)).

orgId

string

Organization id.

Required string length: 1 - 64

Pattern: ^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"or-30tnh-itmjs-s235s5ontr3r23h2"

tenantId

string

Tenant id.

Required string length: 1 - 64

Pattern: ^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"acct-24hka-dhili-9hgvdlvr1ohpibp4"

permissions

string[]

@deprecated - Flat list of API operations the user has access to.

API Authorization

Identity & Access Management

Wallets & Transactions

Management

Webhooks

Deactivate User

Authentication

Required Permissions

Authorizations

Path Parameters

Body

Response

​Authentication

​Required Permissions

Authorizations

Path Parameters

Body

Response

Authentication

Required Permissions