Get anonymization fields

Base URL: https://{kibana_url}

GET /api/security_ai_assistant/anonymization_fields/_find
GET /s/{space_id}/api/security_ai_assistant/anonymization_fields/_find

Auth

Get a list of all anonymization fields.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

fields string[]: Fields to return; Example: ["id","field","anonymized","allowed"]
filter string: Search query; Example: field: "user.name"
sort_field enum: Field to sort by; Values: created_at anonymized allowed field updated_at
sort_order enum: Sort order; Values: asc desc
page integer · min: 1 · default: 1: Page number
per_page integer · min: 0 · default: 20: AnonymizationFields per page
all_data boolean: If true, additionally fetch all anonymization fields, otherwise fetch only the provided page

Responses

Indicates a successful call.

application/json

aggregations object
all object[]
data object[] required: Same fields as all
page integer required
perPage integer required
total integer required

Bad Request response.

application/json

error string
message string
statusCode number

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

curl Shell

curl \
 --request GET 'http://localhost:5601/api/security_ai_assistant/anonymization_fields/_find?page=1&per_page=20' \
 --header "Authorization: $API_KEY"

Response

{
  "aggregations": {
    "field_status": {
      "buckets": {
        "allowed": {
          "doc_count": 1
        },
        "anonymized": {
          "doc_count": 1
        },
        "denied": {
          "doc_count": 1
        }
      }
    }
  },
  "all": [
    {
      "allowed": true,
      "anonymized": true,
      "createdAt": "2023-10-31T12:00:00Z",
      "createdBy": "user1",
      "field": "user.name",
      "id": "1",
      "namespace": "default",
      "timestamp": "2023-10-31T12:00:00Z",
      "updatedAt": "2023-10-31T12:00:00Z",
      "updatedBy": "user1"
    }
  ],
  "data": [
    {
      "allowed": true,
      "anonymized": true,
      "createdAt": "2023-10-31T12:00:00Z",
      "createdBy": "user1",
      "field": "user.name",
      "id": "1",
      "namespace": "default",
      "timestamp": "2023-10-31T12:00:00Z",
      "updatedAt": "2023-10-31T12:00:00Z",
      "updatedBy": "user1"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 100
}

{
  "error": "Bad Request",
  "message": "Invalid request parameters",
  "statusCode": 400
}