Update a User

Update a BloodHound user’s properties’.

PATCH /api/v2/bloodhound-users/{user_id}

Update a User

cURL

curl --request PATCH \
  --url https://bloodhound.specterops.io/openapi.json/api/v2/bloodhound-users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email_address": "[e-mail]",
  "principal": "<string>",
  "roles": [
    123
  ],
  "saml_provider_id": "<string>",
  "sso_provider_id": {
    "int32": 123,
    "valid": true
  },
  "is_disabled": true
}
'

200

"[this request has no response data]"

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

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.

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

Show child attributes

is_disabled · boolean

Response

200

text/plain

No Content This response will contain no response body.

The response is of type string.