Skip to main content
PATCH
/
api
/
v2
/
bloodhound-users
/
{user_id}
Update a User
curl --request PATCH \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/bloodhound-users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email_address": "jsmith@example.com",
  "principal": "<string>",
  "roles": [
    123
  ],
  "saml_provider_id": "<string>",
  "sso_provider_id": {
    "int32": 123,
    "valid": true
  },
  "is_disabled": true
}
'
"[this request has no response data]"

Documentation Index

Fetch the complete documentation index at: https://specterops-bp-2395-ms-sentinel.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
string
default:wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

​
user_id
string<uuid>
required

User ID

Body

application/json

The request body for updating a user

​
first_name
string
​
last_name
string
​
email_address
string<email>
​
principal
string
​
roles
integer<int32>[]
​
saml_provider_id
string
deprecated

Deprecated. Use sso_provider_id instead.

​
sso_provider_id
object

ID of the SSO provider for this user

​
is_disabled
boolean

Response

No Content This response will contain no response body.

The response is of type string.