Get anonymization fields

GET /api/security_ai_assistant/anonymization_fields/_find
Api key auth Basic auth

Get a list of all anonymization fields.

Query parameters

  • fields array[string]

    Fields to return

  • filter string

    Search query

  • sort_field string

    Field to sort by

    Values are created_at, anonymized, allowed, field, or updated_at.

  • sort_order string

    Sort order

    Values are asc or desc.

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

  • per_page integer

    AnonymizationFields per page

    Minimum value is 0. Default value is 20.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • allowed boolean

        Whether this field is allowed to be sent to the model.

      • anonymized boolean

        Whether this field should be anonymized.

      • createdAt string

        Timestamp of when the anonymization field was created.

      • createdBy string

        Username of the person who created the anonymization field.

      • field string Required

        Name of the anonymization field.

      • id string(nonempty) Required

        The ID of the anonymization field.

        Minimum length is 1.

      • namespace string

        Kibana space in which this anonymization field exists.

      • timestamp string(nonempty)

        Timestamp when the anonymization field was initially created.

        Minimum length is 1.

      • updatedAt string

        Timestamp of the last update.

      • updatedBy string

        Username of the person who last updated the field.

    • page integer Required
    • perPage integer Required
    • total integer Required
  • 400 application/json

    Generic Error

    Hide response attributes Show response attributes object
GET /api/security_ai_assistant/anonymization_fields/_find 
curl \
 --request GET 'https://localhost:5601/api/security_ai_assistant/anonymization_fields/_find' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "id": "1",
      "field": "user.name",
      "allowed": true,
      "createdAt": "2023-10-31T12:00:00Z",
      "createdBy": "user1",
      "namespace": "default",
      "timestamp": "2023-10-31T12:00:00Z",
      "updatedAt": "2023-10-31T12:00:00Z",
      "updatedBy": "user1",
      "anonymized": true
    }
  ],
  "page": 1,
  "total": 100,
  "perPage": 20
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "Invalid request parameters",
  "statusCode": 400
}