describe-risk-configuration

Описание

Если настроен защитник от угроз для идентификатора клиента приложения или пула пользователей, описывает конфигурацию риска. Данная операция возвращает подробности адаптивной аутентификации, скомпрометированных учетных данных и списков разрешенных и запрещенных IP-адресов. Для получения дополнительной информации о защите от угроз см. Защита от угроз.

См. также: Документацию AWS API

Синтаксис

  describe-risk-configuration
--user-pool-id <value>
[--client-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--user-pool-id (строка)

Идентификатор пула пользователей с конфигурацией риска, которую вы хотите проверить. Вы можете применить конфигурацию риска по умолчанию на уровне пула пользователей и дополнительно настроить ее от значений по умолчанию пула пользователей на уровне клиента приложения. Укажите ClientId для проверки конфигурации на уровне клиента или UserPoolId для проверки конфигурации на уровне пула.

--client-id (строка)

Идентификатор клиента приложения с конфигурацией риска, которую вы хотите проверить. Вы можете применить конфигурацию риска по умолчанию на уровне пула пользователей и дополнительно настроить ее от значений по умолчанию пула пользователей на уровне клиента приложения. Укажите ClientId для проверки конфигурации на уровне клиента или UserPoolId для проверки конфигурации на уровне пула.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное JSON-значение, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или значением input, выводит JSON-пример входных данных, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входных данных YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команды и вернет пример выходных данных JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

json
text
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

вкл
выкл
авто

--no-sign-request (логическое)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое)

Отключить вывод пейджера для командной строки.

--cli-auto-prompt (логическое)

Автоматически запрашивать входные данные CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запросы входных данных CLI.

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах применяются правила цитирования для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для описания конфигурации риска

В этом примере описывается конфигурация риска, связанная с пулом us-west-2_aaaaaaaaa.

Команда:

aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa

Вывод:

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_IN",
              "SIGN_UP",
              "PASSWORD_CHANGE"
          ],
          "Actions": {
              "EventAction": "BLOCK"
          }
      },
      "AccountTakeoverRiskConfiguration": {
          "NotifyConfiguration": {
              "From": "diego@example.com",
              "ReplyTo": "diego@example.com",
              "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com",
              "BlockEmail": {
                  "Subject": "Blocked sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "NoActionEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              },
              "MfaEmail": {
                  "Subject": "New sign-in attempt",
                  "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>",
                  "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know"
              }
          },
          "Actions": {
              "LowAction": {
                  "Notify": true,
                  "EventAction": "NO_ACTION"
              },
              "MediumAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              },
              "HighAction": {
                  "Notify": true,
                  "EventAction": "MFA_IF_CONFIGURED"
              }
          }
      }
  }
}

Вывод

RiskConfiguration -> (структура)

Подробности запрошенной конфигурации риска.

UserPoolId -> (строка)

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

ClientId -> (строка)

Клиентское приложение, к которому применена эта конфигурация. Если этот параметр отсутствует, конфигурация риска применяется ко всем клиентам приложений пользовательского пула, у которых нет настроек на уровне клиента.

CompromisedCredentialsRiskConfiguration -> (структура)

Настройки для действий при взломе учетных данных и типов аутентификации с защитой от угроз в режиме полной функциональности ENFORCED.

EventFilter -> (список)

Настройки для активности входа, где вы хотите настроить действия при взломе учетных данных. По умолчанию это все события.

(строка)

Actions -> (структура)

Настройки действий, которые должен предпринять ваш пользовательский пул, когда Amazon Cognito обнаруживает взлом учетных данных.

EventAction -> (строка)

Действие, которое Amazon Cognito выполняет при обнаружении взлома учетных данных.

AccountTakeoverRiskConfiguration -> (структура)

Настройки для автоматических ответов и шаблонов уведомлений для адаптивной аутентификации с защитой от угроз.

NotifyConfiguration -> (структура)

Настройки для составления и отправки электронного сообщения, когда защита от угроз оценивает уровень риска с адаптивной аутентификацией. Когда вы выбираете уведомлять пользователей в AccountTakeoverRiskConfiguration, Amazon Cognito отправляет электронное сообщение с использованием метода и шаблона, которые вы установили с помощью этого типа данных.

From -> (строка)

Электронный адрес, с которого отправляется электронное сообщение. Адрес должен быть индивидуально проверен с помощью Amazon Simple Email Service или принадлежать домену, проверенному с помощью Amazon SES.

ReplyTo -> (строка)

Адрес электронной почты для ответа по шаблону сообщения.

SourceArn -> (строка)

Идентификатор ресурса Amazon (ARN) идентификатора, связанного с политикой авторизации отправки. Этот идентификатор разрешает Amazon Cognito отправлять электронное сообщение по адресу, указанному в параметре From.

BlockEmail -> (структура)

Шаблон электронного сообщения, который ваш пользовательский пул отправляет, когда обнаруженное событие риска заблокировано.

Subject -> (строка)

Тема уведомления по электронной почте о защите от угроз.

HtmlBody -> (строка)

Тело уведомления по электронной почте в формате HTML. Выберите HtmlBody или TextBody, чтобы отправить сообщение в формате HTML или в текстовом формате соответственно.

TextBody -> (строка)

Тело уведомления по электронной почте в текстовом формате. Выберите HtmlBody или TextBody, чтобы отправить сообщение в формате HTML или в текстовом формате соответственно.

NoActionEmail -> (структура)

Шаблон электронного сообщения, которое ваш пользовательский пул отправляет, когда на обнаруженное событие риска не предпринимается никаких действий.

Subject -> (строка)

Тема уведомления по электронной почте о защите от угроз.

HtmlBody -> (строка)

TextBody -> (строка)

MfaEmail -> (структура)

Шаблон электронного сообщения, которое ваш пользовательский пул отправляет, когда при обнаружении риска требуется проверка MFA.

Subject -> (строка)

Тема уведомления по электронной почте о защите от угроз.

HtmlBody -> (строка)

TextBody -> (строка)

Actions -> (структура)

Список действий по перехвату учетной записи для каждого уровня риска, который Amazon Cognito может оценить с помощью защиты от угроз.

LowAction -> (структура)

Действие, которое вы назначаете для оценки низкого риска защитой от угроз.

Notify -> (логическое)

Определяет, отправляет ли Amazon Cognito пользователю сообщение об уведомлении, когда ваш пользовательский пул оценивает сеанс пользователя на соответствующем уровне риска.

EventAction -> (строка)

Действие, которое необходимо выполнить для попытки перехвата учетной записи для соответствующего уровня риска. Допустимые значения:

BLOCK : Заблокировать запрос.
MFA_IF_CONFIGURED : Предложить проверку MFA, если возможно. MFA возможна, если в пользовательском пуле есть активные методы MFA, которые пользователь может настроить. Например, если пользовательский пул поддерживает только MFA с SMS-сообщениями, но у пользователя нет атрибута номера телефона, настройка MFA невозможна. Если настройка MFA невозможна, разрешить запрос.
MFA_REQUIRED : Предложить проверку MFA, если возможно. Заблокировать запрос, если пользователь не настраивал MFA. Для входа с необходимой MFA пользователи должны иметь атрибут адреса электронной почты или номера телефона или зарегистрированный фактор TOTP.
NO_ACTION : Не выполнять никаких действий. Разрешить вход.

MediumAction -> (структура)

Действие, которое вы назначаете для оценки среднего риска защитой от угроз.

Notify -> (логическое)

EventAction -> (строка)

BLOCK : Заблокировать запрос.
MFA_IF_CONFIGURED : Предложить проверку MFA, если возможно. MFA возможна, если в пользовательском пуле есть активные методы MFA, которые пользователь может настроить. Например, если пользовательский пул поддерживает только MFA с SMS-сообщениями, но у пользователя нет атрибута номера телефона, настройка MFA невозможна. Если настройка MFA невозможна, разрешить запрос.
MFA_REQUIRED : Предложить проверку MFA, если возможно. Заблокировать запрос, если пользователь не настраивал MFA. Для входа с необходимой MFA пользователи должны иметь атрибут адреса электронной почты или номера телефона или зарегистрированный фактор TOTP.
NO_ACTION : Не выполнять никаких действий. Разрешить вход.

HighAction -> (структура)

Действие, которое вы назначаете для оценки высокого риска защитой от угроз.

Notify -> (логическое)

EventAction -> (строка)

BLOCK : Заблокировать запрос.
MFA_IF_CONFIGURED : Предложить проверку MFA, если возможно. MFA возможна, если в пользовательском пуле есть активные методы MFA, которые пользователь может настроить. Например, если пользовательский пул поддерживает только MFA с SMS-сообщениями, но у пользователя нет атрибута номера телефона, настройка MFA невозможна. Если настройка MFA невозможна, разрешить запрос.
MFA_REQUIRED : Предложить проверку MFA, если возможно. Заблокировать запрос, если пользователь не настраивал MFA. Для входа с необходимой MFA пользователи должны иметь атрибут адреса электронной почты или номера телефона или зарегистрированный фактор TOTP.
NO_ACTION : Не выполнять никаких действий. Разрешить вход.

RiskExceptionConfiguration -> (структура)

Исключения из конфигурации оценки риска, включая всегда-разрешенные и всегда-заблокированные диапазоны IP-адресов.

BlockedIPRangeList -> (список)

Список всегда-заблокированных IP-адресов. Переопределяет решение по риску и всегда блокирует запросы аутентификации. Этот параметр отображается и задается в нотации CIDR.

(строка)

SkippedIPRangeList -> (список)

Список всегда-разрешенных IP-адресов. Обнаружение риска не выполняется для IP-адресов в этом списке диапазонов. Этот параметр отображается и задается в нотации CIDR.

(строка)

LastModifiedDate -> (временная метка)

Дата и время изменения элемента. Amazon Cognito возвращает эту временную метку в формате эпохи UNIX. Ваш SDK может отобразить вывод в удобочитаемом формате, например, ISO 8601 или Java-объекте Date.