API reference Resources

Accounts

People, the presences folded into them, and their history.

3 operations

The Accounts index

GET/people

Query parameters

fstring · null

The filter expression, e.g. all;source~in~connector;enterprise~nin~personal.

The first segment is the join (all or any); each later segment is field~op~values, with op one of in, nin, before, after and values separated by commas. A malformed segment is ignored; a field this list does not have is a 400 naming it.

qstring · null

Free text over the display and the presences' addresses and logins. ANDs with f whichever way its conditions are joined.

cursorstring · null

Where the previous page stopped. Opaque; an unreadable one starts over.

limitinteger · null

Rows wanted. At most 200.

groupstring · null

flat, domain or enterprise — an order and a label, never a fold. An unknown value is a 400 naming the three, for the reason an unknown filter field is.

Response200

facetsPersonFacetsrequired

The four facets, each counting people over the whole matched set.

corporate_addressFacetCount[]required

enterpriseFacetCount[]required

sourceFacetCount[]required

vendorFacetCount[]required

groupstringrequired

The grouping this page was ordered by, echoed from the request.

peoplePersonList[]required

corporate_addressbooleanrequired

True when any presence sits on a domain the workspace owns.

displaystringrequired

What the page calls them — an address, a login, or HOST\user.

first_seen_atstringrequired

idstringrequired

identity_kindstringrequired

email, github_login or os_user.

last_seen_atstringrequired

totalintegerrequired

Every person the filter matched, across all pages, not only this one.

next_cursorstring · null

Pass back as cursor for the next page. null means this was the last.

Errors

400: A filter field this surface does not have, or an unknown group

curl https://api.oxelone.com/people \
  -H "Authorization: Bearer $OXEL_API_KEY"

200 Responseapplication/json

{
  "facets": {
    "corporate_address": [
      {}
    ],
    "enterprise": [
      {}
    ],
    "source": [
      {}
    ],
    "vendor": [
      {}
    ]
  },
  "group": "string",
  "next_cursor": "string",
  "people": [
    {
      "corporate_address": true,
      "display": "string",
      "first_seen_at": "string",
      "group_key": "string",
      "id": "string",
      "identity_kind": "string",
      "last_seen_at": "string",
      "machine_count": 0,
      "presence_count": 0,
      "sources": [],
      "verdicts": {}
    }
  ],
  "total": 0
}

One person, every presence in full

GET/people/{id}

Path parameters

idstringrequired

Response200

displaystringrequired

first_seen_atstringrequired

idstringrequired

identity_keystringrequired

identity_kindstringrequired

last_seen_atstringrequired

machinesPersonMachine[]required

hostnamestringrequired

machine_idstringrequired

presencesintegerrequired

How many of this person's presences sit on it.

presencesPresence[]required

actionsPresenceAction[]required

The connector actions that apply to this kind of presence, and nothing else: a repository action never appears on a person.

corporate_addressbooleanrequired

enterprise_verdictstringrequired

enterprise, personal or unknown.

factsobjectrequired

The metadata the source carried, as keys and values the source chose. Metadata only: never a prompt, a response or a body.

first_seen_atstringrequired

idstringrequired

resolved_atstringrequired

When the resolver last rebuilt this person.

Errors

404: No such person in this workspace

curl https://api.oxelone.com/people/<id> \
  -H "Authorization: Bearer $OXEL_API_KEY"

200 Responseapplication/json

{
  "display": "string",
  "first_seen_at": "string",
  "id": "string",
  "identity_key": "string",
  "identity_kind": "string",
  "last_seen_at": "string",
  "machines": [
    {
      "hostname": "string",
      "machine_id": "string",
      "presences": 0
    }
  ],
  "presences": [
    {
      "actions": [],
      "address": "string",
      "artifact_id": "string",
      "connection_id": "string",
      "connection_name": "string",
      "connector": "string",
      "corporate_address": true,
      "enterprise_evidence": "string",
      "enterprise_verdict": "string",
      "external_id": "string",
      "facts": {},
      "first_seen_at": "string",
      "id": "string",
      "kind_label": "string",
      "last_seen_at": "string",
      "machine_hostname": "string",
      "machine_id": "string",
      "os_user": "string",
      "program": "string",
      "record_kind": "string",
      "role": "string",
      "source": "string",
      "status": "string"
    }
  ],
  "resolved_at": "string"
}

One person's history

GET/people/{id}/history

What happened to one person, newest first: connector actions, events, interactions and issues merged into one list. A 404 for a person this workspace does not hold.

Path parameters

idstringrequired

Query parameters

cursorstring · null

Where the previous page stopped. Opaque; an unreadable one starts over.

limitinteger · null

Items wanted. At most 200.

Response200

itemsHistoryItem[]required

atstringrequired

idstringrequired

kindstringrequired

action, event, interaction or issue.

summarystringrequired

Closed words and the source's own bounded label — never a prompt, a response or a body.

linkstring · null

Where the row opens, workspace-relative. null where nothing renders it.

next_cursorstring · null

Errors

404: No such person in this workspace

curl https://api.oxelone.com/people/<id>/history \
  -H "Authorization: Bearer $OXEL_API_KEY"

200 Responseapplication/json

{
  "items": [
    {
      "at": "string",
      "id": "string",
      "kind": "string",
      "link": "string",
      "summary": "string"
    }
  ],
  "next_cursor": "string"
}