Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

отключить поставщика для пользователя

Описание

Препятствует входу пользователя с указанным внешним (SAML или социальным) поставщиком идентификации (IdP). Если пользователь, которого вы хотите деактивировать, является обычным пользователем Amazon Cognito пользовательских пулов с именем пользователя и паролем, он не сможет войти с помощью пароля. Если пользователь, который должен быть деактивирован, является связанным пользователем внешнего IdP, любая связь между этим пользователем и существующим пользователем будет удалена. Когда внешний пользователь снова войдёт, а пользователь больше не привязан к ранее связанному DestinationUser, пользователю необходимо создать новую учётную запись.

Значение ProviderName должно соответствовать имени поставщика IdP пула пользователей.

Для деактивации локального пользователя установите ProviderName в значение Cognito и ProviderAttributeName в значение Cognito_Subject. ProviderAttributeValue должно быть локальным именем пользователя.

ProviderAttributeName должно всегда быть Cognito_Subject для социальных IdP. ProviderAttributeValue всегда должно быть точным субъектом, который использовался при первоначальной привязке пользователя в качестве исходного пользователя.

Для отключения привязки SAML-идентификатора существуют два сценария. Если связанный идентификатор ещё не использовался для входа, ProviderAttributeName и ProviderAttributeValue должны быть такими же, как те, которые использовались для SourceUser при первоначальной привязке идентификаторов с помощью вызова AdminLinkProviderForUser. Это также верно, если привязка была выполнена с ProviderAttributeName, установленным в значение Cognito_Subject. Если пользователь уже вошёл, ProviderAttributeName должен быть Cognito_Subject, а ProviderAttributeValue должен быть NameID из утверждения SAML.

Примечание

Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для этой API-операции. Для этой операции вы должны использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.

Подробнее
  • Подписание запросов к API Amazon Web Services
  • Использование API пулов пользователей Amazon Cognito и конечных точек пула пользователей

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

Синтаксис

  admin-disable-provider-for-user
--user-pool-id <value>
--user <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 (строка)

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

--user (структура)

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

ProviderName -> (строка)

Имя поставщика, например, Facebook, Google или Login with Amazon.

ProviderAttributeName -> (строка)

Имя атрибута поставщика для привязки, например, NameID.

ProviderAttributeValue -> (строка)

Значение атрибута поставщика для привязки, например, xxxxx_account.

Упрощённый синтаксис:

ProviderName=string,ProviderAttributeName=string,ProviderAttributeValue=string

Синтаксис JSON:

{
  "ProviderName": "string",
  "ProviderAttributeName": "string",
  "ProviderAttributeValue": "string"
}

--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
  • table
  • yaml
  • yaml-stream

--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 для вывода.

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее об этом см. руководство по началу работы в руководстве пользователя AWS CLI.

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

Для отключения федеративного пользователя от локального профиля пользователя

Следующий admin-disable-provider-for-user пример отключает пользователя Google от связанного локального профиля.

aws cognito-idp admin-disable-provider-for-user \
    --user-pool-id us-west-2_EXAMPLE \
    --user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google

Дополнительную информацию см. в разделе Привязка федеративных пользователей к существующему профилю пользователя в руководстве разработчика Amazon Cognito.

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API