GET
/
api
/
v2
/
roles
{
  "data": {
    "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>"
          }
        ]
      }
    ]
  }
}
Applies to BloodHound Enterprise and CE

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 name, description, id, created_at, updated_at, deleted_at.

​
name
string

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

​
id
integer

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

​
created_at
string<date-time>

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

​
updated_at
string<date-time>

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

​
deleted_at
string<date-time>

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

Response

200
application/json

OK

The response is of type object.