Update User Group

curl --request PUT \
  --url https://api.dfns.io/auth/user-groups/{userGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.dfns.io/auth/user-groups/{userGroupId}"

payload = {
    "name": "<string>",
    "description": "<string>"
}
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({name: '<string>', description: '<string>'})
};

fetch('https://api.dfns.io/auth/user-groups/{userGroupId}', 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/user-groups/{userGroupId}",
  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([
    'name' => '<string>',
    'description' => '<string>'
  ]),
  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/user-groups/{userGroupId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\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/user-groups/{userGroupId}")
  .header("Authorization", "Bearer <token>")
  .header("X-DFNS-USERACTION", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/auth/user-groups/{userGroupId}")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "ug-139tf-f58l8-lsbt6dp47lfsdvgh",
  "name": "<string>",
  "memberCount": 1,
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "dateUpdated": "2023-04-14T20:41:28.715Z",
  "orgId": "or-30tnh-itmjs-s235s5ontr3r23h2",
  "tenantId": "acct-24hka-dhili-9hgvdlvr1ohpibp4",
  "description": "<string>"
}

PUT

auth

user-groups

{userGroupId}

Update User Group

curl --request PUT \
  --url https://api.dfns.io/auth/user-groups/{userGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.dfns.io/auth/user-groups/{userGroupId}"

payload = {
    "name": "<string>",
    "description": "<string>"
}
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({name: '<string>', description: '<string>'})
};

fetch('https://api.dfns.io/auth/user-groups/{userGroupId}', 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/user-groups/{userGroupId}",
  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([
    'name' => '<string>',
    'description' => '<string>'
  ]),
  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/user-groups/{userGroupId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\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/user-groups/{userGroupId}")
  .header("Authorization", "Bearer <token>")
  .header("X-DFNS-USERACTION", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/auth/user-groups/{userGroupId}")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "id": "ug-139tf-f58l8-lsbt6dp47lfsdvgh",
  "name": "<string>",
  "memberCount": 1,
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "dateUpdated": "2023-04-14T20:41:28.715Z",
  "orgId": "or-30tnh-itmjs-s235s5ontr3r23h2",
  "tenantId": "acct-24hka-dhili-9hgvdlvr1ohpibp4",
  "description": "<string>"
}

Authentication

✅ Tenant User (TenantUser)
✅ Organization User (CustomerEmployee)
❌ End User (EndUser)
✅ Service Account

Required Permissions

Auth:UserGroups:Update: 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

userGroupId

string

required

User group id.

Required string length: 1 - 64

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

Body

application/json

name

string

Name of the group. Unique within the org or tenant, ignoring case. A deleted group frees its name for reuse.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_+.-]+$

description

string | null

Description of the group. Null removes it.

Required string length: 1 - 1024

Response

200 - application/json

Success

string

required

User group id.

Required string length: 1 - 64

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

Example:

"ug-139tf-f58l8-lsbt6dp47lfsdvgh"

name

string

required

Name of the group.

memberCount

integer

required

Number of members.

Required range: x >= 0

dateCreated

string<date-time>

required

ISO 8601 date (must be UTC). Date the group was created.

Example:

"2023-04-14T20:41:28.715Z"

dateUpdated

string<date-time>

required

ISO 8601 date (must be UTC). Date the group was last updated.

Example:

"2023-04-14T20:41:28.715Z"

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"

description

string

Description of the group.

API Authorization

Identity & Access Management

Wallets & Transactions

Management

Webhooks

Update User Group

Authentication

Required Permissions

Authorizations

Path Parameters

Body

Response

​Authentication

​Required Permissions

Authorizations

Path Parameters

Body

Response

Authentication

Required Permissions