v1

latestOpenAPI 3.0.02026-07-17508972.4 KB

AuthKeys

Get auth keys list

get/authKeys/index

Query parameters

quickFilterstring

Example:user@example.com

Quick filter used to match multiple attributes such as name, description, emails, etc.

Response

Auth key list response

idinteger

uuidstring uuid

authkeystring

authkey_startstring

authkey_endstring

createdinteger

UNIX timestamp

expirationinteger

0 or UNIX timestamp

user_idinteger

commentstring

Example response

[
  {
    "id": 1,
    "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
    "authkey_start": "abcd",
    "authkey_end": "abcd",
    "user_id": 1,
    "user": {
      "id": 1,
      "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
      "username": "admin",
      "role_id": 1,
      "individual_id": 1,
      "created": "2022-01-05T11:19:26+00:00",
      "modified": "2022-01-05T11:19:26+00:00",
      "organisation_id": 1,
      "organisation": {
        "id": 1,
        "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
        "created": "2022-01-05T11:19:26+00:00",
        "modified": "2022-01-05T11:19:26+00:00",
        "tags": [
          {
            "id": 1,
            "name": "white",
            "namespace": "tlp",
            "colour": "FFFFFF",
            "text_colour": "white",
            "created": "2022-01-05T11:19:26+00:00",
            "modified": "2022-01-05T11:19:26+00:00"
          }
        ]
      },
      "individual": {
        "id": 1,
        "uuid": "c99506a6-1255-4b71-afa5-7b8ba48c3b1b",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "position": "Security Analyst",
        "tags": [
          {
            "id": 1,
            "name": "white",
            "namespace": "tlp",
            "colour": "FFFFFF",
            "text_colour": "white",
            "created": "2022-01-05T11:19:26+00:00",
            "modified": "2022-01-05T11:19:26+00:00"
          }
        ],
        "created": "2022-01-05T11:19:26+00:00",
        "modified": "2022-01-05T11:19:26+00:00"
      },
      "role": {
        "id": 1,
        "name": "admin"
      }
    }
  }
]