В этом документе представлена информация о функции "Просмотр журналов аудита" и его использовании, в частности с помощью инструмента Swagger.
"Просмотр журналов аудита" дает возможность получить детали журнала аудита текущего пользователя.
Для того чтобы начать получать информацию, функция API должна быть активна на учетной записи пользователя и должен быть сгенерирован токен.
Шаги для генерации токена в учетной записи, которая уже имеет активную функцию API
1. Перейдите в раздел "Настройки API".
2. Нажмите на ссылку "нажмите здесь", чтобы перейти к разделу "Токены персонального доступа"
3. Нажмите на кнопку "Сгенерировать новый токен".
4. Введите имя токена и проверьте разрешения
5. Нажмите на кнопку "Сохранить маркер" кнопку
Сгенерированный токен должен использоваться для дальнейшей авторизации в инструменте Swagger. Сгенерированные маркеры можно редактировать, отзывать и удалять.
Как использовать API для раздела "Просмотр журналов аудита"?
Предпосылки
- Функция API активна для учетной записи
- Сгенерированный токен
- Проверено разрешение для сгенерированного токена - пользователь: журналы аудита
- Токен на предъявителя для авторизации
Шаги по авторизации пользователя для дальнейшего использования API для "Просмотр журналов аудита" с помощью Swagger
1. Перейдите в раздел "Настройки API".
2. Нажмите на ссылку "Документация API", чтобы перейти к разделу Swagger
3. Нажмите на кнопку "Авторизация"
4. Tвведите Bearer в открывшемся модале и оставьте пробел после него (см. скриншот ниже)
5. Скопируйте сгенерированный токен из раздела "Personal Access Tokens" (Настройки API >" нажмите здесь ссылку"> раздел Personal Access Tokens>Copy token).
6. Вставьте скопированный токен в открывшееся модальное окно после Bearer
7. Нажмите на кнопку "Авторизация"
8. Нажмите на кнопку "Закрыть"
9. После успешной авторизации кнопка будет выглядеть так, как показано на скриншоте ниже
10. Теперь пользователь успешно авторизован и может начать использовать API с помощью инструмента Swagger!
Шаги по использованию API для "Просмотр журналов аудита" с помощью Swagger
PowerDMARC документация по API содержит инструкции по API для различных разделов платформы.
Предпосылки:
- Сгенерированный токен
- Авторизованный пользователь (см. шаги выше) на Swagger
Шаги для начала использования API для "просмотра журналов аудита" с помощью Swagger
1. Введите "Просмотр журналов аудита" в поле поиска
2. Расширить информацию
3. Нажмите на кнопку "Попробовать"
4. Просмотр Журналы аудита можно фильтровать только по дате (от/до, формат даты - год/месяц/день), кроме того, в параметрах можно указать номер страницы и количество элементов на странице
5. Укажите количество элементов на странице, номер страницы и фильтр по дате (см. снимок экрана ниже).
6. Нажмите на кнопку "Выполнить"
7. Проверьте информацию о запросе (Curl, URL запроса) и ответе (код состояния, тело ответа, заголовки ответа).
Возможные коды состояния ответа:
- Код состояния 200 в ответе означает, что запрос был успешно обработан и информация об ответе доступна пользователю.
- 401 означает, что пользователь не авторизован (токен не предоставлен, или он недействителен)
- 403 означает, что у пользователя нет разрешения на получение запрашиваемого ресурса (разрешения не указываются при генерации нового токена)
Надеюсь, этот урок знаний был полезен для вас. Чтобы пользоваться безопасной электронной почтой, начните проверять подлинность своих писем с помощью DMARC уже сегодня!
