global-sign-out

Описание

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

• Amazon Cognito больше не принимает операции с пользователями, авторизованными с помощью токенов доступа пользователя, вышедшего из системы. Для получения дополнительной информации см. Использование API и конечных точек пользовательских пулов Amazon Cognito. Amazon Cognito возвращает ошибку Access Token has been revoked, когда ваша программа пытается авторизовать запрос API пула пользователей с помощью аннулированного токена доступа, содержащего область aws.cognito.signin.user.admin.
• Amazon Cognito больше не принимает токен пользователя, вышедшего из системы, в запросе GetId к пулу идентификации с ServerSideTokenCheck, включенным для конфигурации IdP пула пользователей в CognitoIdentityProvider.
• Amazon Cognito больше не принимает токены обновления пользователя, вышедшего из системы, в запросах обновления.

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

Авторизуйте это действие с помощью токена доступа вошедшего в систему пользователя. Он должен включать область aws.cognito.signin.user.admin.

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

Синтаксис

  global-sign-out
--access-token <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]

Параметры

--access-token (строка)

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (булево)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Чтобы выйти из текущей системы

Следующий global-sign-out пример выводит текущего пользователя из системы.

aws cognito-idp global-sign-out \
    --access-token eyJra456defEXAMPLE

Эта команда не выводит ничего.

Дополнительную информацию см. в разделе Управление пользователями в Руководстве разработчика Amazon Cognito.

Вывод

Ничего