Enrolls user in multi-factor authentication

Enrolls user in multi-factor authentication

POST /api/v2/bloodhound-users/{user_id}/mfa

Enrolls user in multi-factor authentication

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/bloodhound-users/{user_id}/mfa \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret": "<string>"
}
'

200

{
  "data": {
    "qr_code": "<string>",
    "totp_secret": "<string>"
  }
}

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. 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 enrolling a user in multi-factor authentication

secret · string

Response

200

application/json

OK

data · object

Show child attributes