Skip to main content
PATCH
/
api
/
v2
/
bloodhound-users
/
{user_id}
Error
A valid request URL is required to generate request examples
"[this request has no response data]"
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Path Parameters

​
user_id
string<uuid>
required

User ID

Body

application/json

The request body for updating a user

​
all_environments
boolean
required

Grants access to all environments for the user. This will clear a user's environment access control list, if it exists

​
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
​
environment_targeted_access_control
object

Sets an environment targeted access control on the user. When all_environments is set to true, a user's existing environment control is cleared and they are granted access to all environments. Administrators and Power Users may not have an ETAC list applied to them.

Response

No Content This response will contain no response body.

The response is of type string.