Перейти к основному содержимому
API docs by Redocly

Jay Guard API (v0)

Download OpenAPI specification:Download

Audit Events

Экспорт событий аудита.

Экспорт событий аудита

Экспорт событий аудита по заданным параметрам.

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

АPI-токен для аутентификации. Формат: Bearer {токен}.

Request Body schema: application/json
required
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

Content type
application/json
{
  • "createdFrom": "2019-08-24T14:15:22Z",
  • "createdTo": "2019-08-24T14:15:22Z",
  • "application": "string",
  • "apiKeys": [
    ],
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "auditEvents": [
    ]
}

Экспорт детальной информации по событиям аудита

Экспорт детальной информации событий аудита по их идентификаторам.

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

АPI-токен для аутентификации. Формат: Bearer {токен}.

Request Body schema: application/json
required
eventIds
required
Array of integers <int64> unique [ items <int64 > ]

Идентификаторы событий аудита, для которых нужна детальная информация. Идентификаторы можно получить с помощью метода POST /api/dataguard/public/audit/list.

Responses

Request samples

Content type
application/json
{
  • "eventIds": [
    ]
}

Response samples

Content type
application/json
{
  • "auditDetails": [
    ]
}

User masking

Маскирование и демаскирование сущностей в тексте.

Демаскирование сущностей

Получение текста с оригинальными, немаскированными значениями по идентификатору маскировки.

Authorizations:
data-guard-api-key
header Parameters
X-DATA-GUARD-API-KEY
required
string

Ключ доступа к Jay Guard. Можно получить в интерфейсе.

Request Body schema: application/json
required
maskedText
required
string

Текст с маскированными сущностями.

maskingId
required
string <uuid>

Идентификатор маскировки. Приходит в ответ на запрос POST /api/dataguard/public/user-masking/mask.

Responses

Request samples

Content type
application/json
{
  • "maskedText": "<jg:person_1> родился <jg:date_2> года в <jg:location_3>. Сейчас он работает менеджером в международной IT-компании.",
  • "maskingId": "36b74425-3a77-47e1-bdf5-519cbc452080"
}

Response samples

Content type
application/json
{
  • "text": "Игнат Иванович Сикорский родился 1.05.1991 года в Алапаевске. Сейчас он работает менеджером в международной IT-компании."
}

Маскирование сущностей

Получение текста с маскированными сущностями.

Authorizations:
data-guard-api-key
header Parameters
X-DATA-GUARD-API-KEY
required
string

Ключ доступа к Jay Guard. Можно получить в интерфейсе.

Request Body schema: application/json
required
text
required
string

Текст, в котором сущности нужно заменить на плейсхолдеры. Список искомых сущностей указывается в фильтре, который привязан к ключу доступа. Настроить фильтр и привязать его к ключу можно в интерфейсе Jay Guard.

Responses

Request samples

Content type
application/json
{
  • "text": "Игнат Иванович Сикорский родился 1.05.1991 года в Алапаевске. Сейчас он работает менеджером в международной IT-компании."
}

Response samples

Content type
application/json
{
  • "maskedText": "<jg:person_1> родился <jg:date_2> года в <jg:location_3>. Сейчас он работает менеджером в международной IT-компании.",
  • "maskingId": "36b74425-3a77-47e1-bdf5-519cbc452080",
  • "action": "allow",
  • "reasons": [
    ]
}

Proxy requests

Проксирование запросов с маскированием сущностей.

Проксирование запросов

Проксирование запросов с маскированием сущностей. Подробнее о том, как использовать этот метод, форматах запроса и ответа читайте в документации.

Authorizations:
data-guard-api-key
path Parameters
serviceName
required
string
Enum: "gigachat" "mlp" "openai" "yandexGpt"

Внутреннее название сервиса, на который будет отправлен запрос после его маскирования.

proxyPath
required
string

Путь для проксирования запроса. Например, /v1/chat/completions.

header Parameters
X-DATA-GUARD-API-KEY
required
string

Ключ доступа к Jay Guard. Можно получить в интерфейсе.

Responses

Response samples

Content type
application/json
{
  • "response": { }
}