Skip to main content
DELETE
/
auth
/
users
/
{userId}
Delete User
curl --request DELETE \
  --url https://api.dfns.io/auth/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-DFNS-USERACTION: <api-key>'
{
  "username": "<string>",
  "name": "<string>",
  "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
  "kind": "CustomerEmployee",
  "credentialUuid": "<string>",
  "orgId": "<string>",
  "isActive": true,
  "isServiceAccount": true,
  "isRegistered": true,
  "isSSORequired": true,
  "permissionAssignments": [
    {
      "permissionName": "<string>",
      "permissionId": "<string>",
      "assignmentId": "<string>",
      "operations": [
        "<string>"
      ]
    }
  ],
  "permissions": [
    "<string>"
  ]
}

​
Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Auth:Users:Delete: 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
Minimum string length: 1

Response

200 - application/json

Success

​
username
string
required
​
name
string
required
​
userId
string
required

User id.

Required string length: 1 - 64
Example:

"us-6b58p-r53sr-rlrd3l5cj3uc4ome"

​
kind
enum<string>
required

User kind.

Available options:
CustomerEmployee,
EndUser
​
credentialUuid
string
required
​
orgId
string
required
​
isActive
boolean
required
​
isServiceAccount
boolean
required
​
isRegistered
boolean
required
​
isSSORequired
boolean
required
​
permissionAssignments
object[]
required
​
permissions
string[]