Skip to main content
POST
/
api
/
v2
/
bloodhound-users
Create a New User
curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/bloodhound-users \
  --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,
  "secret": "<string>",
  "needs_password_reset": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": {
      "time": "2023-11-07T05:31:56Z",
      "valid": true
    },
    "saml_provider_id": {
      "int32": 123,
      "valid": true
    },
    "sso_provider_id": {
      "int32": 123,
      "valid": true
    },
    "AuthSecret": {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "digest_method": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "totp_activated": true
    },
    "roles": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": {
          "time": "2023-11-07T05:31:56Z",
          "valid": true
        },
        "name": "<string>",
        "description": "<string>",
        "permissions": [
          {
            "id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": {
              "time": "2023-11-07T05:31:56Z",
              "valid": true
            },
            "authority": "<string>",
            "name": "<string>"
          }
        ]
      }
    ],
    "first_name": {
      "string": "<string>",
      "valid": true
    },
    "last_name": {
      "string": "<string>",
      "valid": true
    },
    "email_address": {
      "string": "<string>",
      "valid": true
    },
    "principal_name": "<string>",
    "last_login": "2023-11-07T05:31:56Z",
    "is_disabled": true,
    "eula_accepted": true
  }
}

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]+)$

Body

application/json

The request body for creating 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
​
secret
string
​
needs_password_reset
boolean

Response

OK

​
data
object