Jay Guard API (v0)
Download OpenAPI specification:Download
Экспорт событий аудита
Экспорт событий аудита по заданным параметрам.
Authorizations:
header Parameters
| Authorization required | string АPI-токен для аутентификации. Формат: |
Request Body schema: application/jsonrequired
| createdFrom | string <date-time> Дата и время начала периода, за который нужно прислать события аудита. |
| createdTo | string <date-time> Дата и время окончания периода, за который нужно прислать события аудита. |
| application | string Идентификатор приложения Jay Copilot, для которого нужно прислать события аудита. Чтобы получить идентификаторы, используйте метод: GET /api/appsAdapter/templates. |
| apiKeys | Array of strings unique Ключи доступа, для которых нужно прислать события аудита. |
| limit | integer <int32> Количество событий аудита, которое нужно прислать. |
| offset | integer <int32> Смещение от начала списка событий аудита. |
Responses
Request samples
- Payload
{- "createdFrom": "2019-08-24T14:15:22Z",
- "createdTo": "2019-08-24T14:15:22Z",
- "application": "string",
- "apiKeys": [
- "string"
], - "limit": 0,
- "offset": 0
}Response samples
- 200
- 400
{- "auditEvents": [
- {
- "eventId": 0,
- "requestId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "userId": "string",
- "email": "string",
- "appliedRules": [
- "string"
], - "action": "allow",
- "filter": {
- "id": 0,
- "name": "string"
}, - "application": "string",
- "message": "string"
}
]
}Экспорт детальной информации по событиям аудита
Экспорт детальной информации событий аудита по их идентификаторам.
Authorizations:
header Parameters
| Authorization required | string АPI-токен для аутентификации. Формат: |
Request Body schema: application/jsonrequired
| eventIds required | Array of integers <int64> unique [ items <int64 > ] Идентификаторы событий аудита, для которых нужна детальная информация. Идентификаторы можно получить с помощью метода POST /api/dataguard/public/audit/list. |
Responses
Request samples
- Payload
{- "eventIds": [
- 123,
- 456,
- 789
]
}Response samples
- 200
- 400
{- "auditDetails": [
- {
- "eventId": 123,
- "content": "Игнат Иванович Сикорский родился 1.05.1991 года в Алапаевске. Сейчас он работает менеджером в международной IT-компании.",
- "maskedContent": "[jg:person_1] родился [jg:date_2] года в [jg:location_3]. Сейчас он работает менеджером в международной IT-компании.",
- "details": [
- {
- "searchMethodId": "person-rus-ner",
- "value": "Игнат Иванович Сикорский"
}
]
}
]
}Демаскирование сущностей
Получение текста с оригинальными, немаскированными значениями по идентификатору маскировки.
Authorizations:
header Parameters
| X-DATA-GUARD-API-KEY required | string Ключ доступа к Jay Guard. Можно получить в интерфейсе. |
Request Body schema: application/jsonrequired
| maskedText required | string Текст с маскированными сущностями. |
| maskingId required | string <uuid> Идентификатор маскировки. Приходит в ответ на запрос POST /api/dataguard/public/user-masking/mask. |
Responses
Request samples
- Payload
{- "maskedText": "<jg:person_1> родился <jg:date_2> года в <jg:location_3>. Сейчас он работает менеджером в международной IT-компании.",
- "maskingId": "36b74425-3a77-47e1-bdf5-519cbc452080"
}Response samples
- 200
- 400
{- "text": "Игнат Иванович Сикорский родился 1.05.1991 года в Алапаевске. Сейчас он работает менеджером в международной IT-компании."
}Маскирование сущностей
Получение текста с маскированными сущностями.
Authorizations:
header Parameters
| X-DATA-GUARD-API-KEY required | string Ключ доступа к Jay Guard. Можно получить в интерфейсе. |
Request Body schema: application/jsonrequired
| text required | string Текст, в котором сущности нужно заменить на плейсхолдеры. Список искомых сущностей указывается в фильтре, который привязан к ключу доступа. Настроить фильтр и привязать его к ключу можно в интерфейсе Jay Guard. |
Responses
Request samples
- Payload
{- "text": "Игнат Иванович Сикорский родился 1.05.1991 года в Алапаевске. Сейчас он работает менеджером в международной IT-компании."
}Response samples
- 200
- 400
{- "maskedText": "<jg:person_1> родился <jg:date_2> года в <jg:location_3>. Сейчас он работает менеджером в международной IT-компании.",
- "maskingId": "36b74425-3a77-47e1-bdf5-519cbc452080",
- "action": "allow",
- "reasons": [
- "person",
- "date",
- "location"
]
}Проксирование запросов
Проксирование запросов с маскированием сущностей. Подробнее о том, как использовать этот метод, форматах запроса и ответа читайте в документации.
Authorizations:
path Parameters
| serviceName required | string Enum: "gigachat" "mlp" "openai" "yandexGpt" Внутреннее название сервиса, на который будет отправлен запрос после его маскирования. |
| proxyPath required | string Путь для проксирования запроса. Например, |
header Parameters
| X-DATA-GUARD-API-KEY required | string Ключ доступа к Jay Guard. Можно получить в интерфейсе. |
Responses
Response samples
- 200
- 400
{- "response": { }
}