List Users

Gets all BloodHound user details.

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

Query Parameters

sort_by

string

Sortable columns are first_name, last_name, email_address, principal_name, last_login, created_at, updated_at, deleted_at.

first_name

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

last_name

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

email_address

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

principal_name

string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

id

string

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

last_login

string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_at

string

Filter results by created_at value. See filter schema details for valid predicates.

updated_at

string

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_at

string

Filter results by deleted_at value. See filter schema details for valid predicates.

Response

200

application/json

OK

data

object

Show child attributes

data.users

object[]

Show child attributes

data.users.id

string

This is the unique identifier for this object.

data.users.created_at

string

data.users.updated_at

string

data.users.deleted_at

object

Show child attributes

data.users.deleted_at.time

string

An RFC-3339 formatted string

data.users.deleted_at.valid

boolean

Valid is true if time is not null.

data.users.saml_provider_id

object

deprecated

Deprecated. Use sso_provider_id instead.

Show child attributes

data.users.saml_provider_id.int32

integer

data.users.saml_provider_id.valid

boolean

Valid is true if int32 is not null.

data.users.sso_provider_id

object

ID of the SSO provider for this user

Show child attributes

data.users.sso_provider_id.int32

integer

data.users.sso_provider_id.valid

boolean

Valid is true if int32 is not null.

data.users.AuthSecret

object

Show child attributes

data.users.AuthSecret.id

integer

This is the unique identifier for this object.

data.users.AuthSecret.created_at

string

data.users.AuthSecret.updated_at

string

data.users.AuthSecret.deleted_at

object

Show child attributes

data.users.AuthSecret.deleted_at.time

string

An RFC-3339 formatted string

data.users.AuthSecret.deleted_at.valid

boolean

Valid is true if time is not null.

data.users.AuthSecret.digest_method

string

data.users.AuthSecret.expires_at

string

data.users.AuthSecret.totp_activated

boolean

data.users.roles

object[]

Show child attributes

data.users.roles.id

integer

This is the unique identifier for this object.

data.users.roles.created_at

string

data.users.roles.updated_at

string

data.users.roles.deleted_at

object

Show child attributes

data.users.roles.deleted_at.time

string

An RFC-3339 formatted string

data.users.roles.deleted_at.valid

boolean

Valid is true if time is not null.

data.users.roles.name

string

data.users.roles.description

string

data.users.roles.permissions

object[]

Show child attributes

data.users.roles.permissions.id

integer

This is the unique identifier for this object.

data.users.roles.permissions.created_at

string

data.users.roles.permissions.updated_at

string

data.users.roles.permissions.deleted_at

object

Show child attributes

data.users.roles.permissions.authority

string

data.users.roles.permissions.name

string

data.users.first_name

object

Show child attributes

data.users.first_name.string

string

data.users.first_name.valid

boolean

Valid is true if string`` is not null`

data.users.last_name

object

Show child attributes

data.users.last_name.string

string

data.users.last_name.valid

boolean

Valid is true if string`` is not null`

data.users.email_address

object

Show child attributes

data.users.email_address.string

string

data.users.email_address.valid

boolean

Valid is true if string`` is not null`

data.users.principal_name

string

data.users.last_login

string

data.users.is_disabled

boolean

data.users.eula_accepted

boolean