Create a New User

Create a new BloodHound user.

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

Body

application/json

The request body for creating a user

first_name

string

last_name

string

email_address

string

principal

string

roles

integer[]

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

sso_provider_id.int32

integer

sso_provider_id.valid

boolean

Valid is true if int32 is not null.

is_disabled

boolean

secret

string

needs_password_reset

boolean

Response

200

application/json

OK

data

object

Show child attributes

data.id

string

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

Show child attributes

data.deleted_at.time

string

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.saml_provider_id

object

deprecated

Deprecated. Use sso_provider_id instead.

Show child attributes

data.saml_provider_id.int32

integer

data.saml_provider_id.valid

boolean

Valid is true if int32 is not null.

data.sso_provider_id

object

ID of the SSO provider for this user

Show child attributes

data.sso_provider_id.int32

integer

data.sso_provider_id.valid

boolean

Valid is true if int32 is not null.

data.AuthSecret

object

Show child attributes

data.AuthSecret.id

integer

This is the unique identifier for this object.

data.AuthSecret.created_at

string

data.AuthSecret.updated_at

string

data.AuthSecret.deleted_at

object

Show child attributes

data.AuthSecret.deleted_at.time

string

An RFC-3339 formatted string

data.AuthSecret.deleted_at.valid

boolean

Valid is true if time is not null.

data.AuthSecret.digest_method

string

data.AuthSecret.expires_at

string

data.AuthSecret.totp_activated

boolean

data.roles

object[]

Show child attributes

data.roles.id

integer

This is the unique identifier for this object.

data.roles.created_at

string

data.roles.updated_at

string

data.roles.deleted_at

object

Show child attributes

data.roles.deleted_at.time

string

An RFC-3339 formatted string

data.roles.deleted_at.valid

boolean

Valid is true if time is not null.

data.roles.name

string

data.roles.description

string

data.roles.permissions

object[]

Show child attributes

data.roles.permissions.id

integer

This is the unique identifier for this object.

data.roles.permissions.created_at

string

data.roles.permissions.updated_at

string

data.roles.permissions.deleted_at

object

Show child attributes

data.roles.permissions.deleted_at.time

string

An RFC-3339 formatted string

data.roles.permissions.deleted_at.valid

boolean

Valid is true if time is not null.

data.roles.permissions.authority

string

data.roles.permissions.name

string

data.first_name

object

Show child attributes

data.first_name.string

string

data.first_name.valid

boolean

Valid is true if string`` is not null`

data.last_name

object

Show child attributes

data.last_name.string

string

data.last_name.valid

boolean

Valid is true if string`` is not null`

data.email_address

object

Show child attributes

data.email_address.string

string

data.email_address.valid

boolean

Valid is true if string`` is not null`

data.principal_name

string

data.last_login

string

data.is_disabled

boolean

data.eula_accepted

boolean