v1

latestOpenAPI 3.1.0Elastic 2.02026-07-179371211.2 KB

Clients

Get API Clients

Returns all existing API clients.

get/connect/clients/

Response

The array of Client objects

createTimestring

The date and time when this API client was created

idstring

The ID assigned to this API client

namestring

The client name

notestring

An optional note to associate with this API client

permissionsstring[]

The list of permissions assigned to this client

searchUsernamestring

An optional Elasticsearch user that this client will run as when accessing event data

secretstring

The generated client secret (only returned on new client creation and regeneration of the secret)

updateTimestring

The date and time when this API client was last modified

Example response

[
  {
    "createTime": "2024-12-03T21:04:59.970640998Z",
    "id": "socl_my_new_api_client",
    "name": "My New API Client",
    "note": "This client is used for automating case observable attachments",
    "permissions": [
      "events/read",
      "cases/read",
      "cases/write"
    ],
    "secret": "ERa5jp9Z6WbLm1YC5FCM",
    "updateTime": "0001-01-01T00:00:00Z"
  }
]