Skip to main content
POST
/
api
/
v2
/
login
Login to BloodHound
curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "login_method": "secret",
  "username": "cool_user@bloodhoundenterprise.io",
  "secret": "MySup3rS3cr3tPassw0rd!!!"
}
'
{
  "data": {
    "user_id": "54623566-213a-4490-9c68-ac44c39b6590",
    "auth_expired": false,
    "session_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiNTQ2MjM1NjYtMjEzYS00NDkwLTljNjgtYWM0NGMzOWI2NTkwIiwidXNlciI6ImNvb2xfdXNlckBibG9vZGhvdW5kZW50ZXJwcmlzZS5pbyIsImlhdCI6MTUxNjIzOTAyMn0.1WWo7XpE9a-v6MQ9tHC8ikxmvmS3PuD7bJyNi4hPr_Y"
  }
}

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

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 logging into the application. secret or otp is required, but not both.

​
login_method
enum<string>
required

The type of login. Currently only secret is supported.

Available options:
secret
​
username
string
required
​
secret
string

The password for the user. This field can be used instead of otp.

​
otp
string

The One Time Password for a single login. This field can be used instead of secret

Response

OK

​
data
object