admin-link-provider-for-user

Описание

Связывает существующую учетную запись пользователя в пуле пользователей или DestinationUser с идентификатором из внешнего IdP или SourceUser, на основе указанного имени и значения атрибута из внешнего IdP.

Данная операция соединяет локальный профиль пользователя с идентификатором пользователя, который еще не вошел в систему с помощью своего IdP от третьей стороны. Когда пользователь входит в систему с помощью своего IdP, он получает настройки контроля доступа из локального профиля пользователя. Связанные локальные пользователи также могут войти в систему с помощью операций API на основе SDK, таких как InitiateAuth, после того, как они хотя бы один раз войдут в систему через свой IdP. Дополнительную информацию см. в разделе Связывание пользователей с федерацией.

Примечание

Максимальное количество идентификаторов федерации, связанных с пользователем, равно пяти.

Предупреждение

Поскольку этот API позволяет пользователю с внешним идентификатором федерации войти в систему как локальный пользователь, крайне важно использовать его только с внешними IdP и связанными атрибутами, которым вы доверяете.

Примечание

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

Узнать больше

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

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

Синтаксис

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

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

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

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

Для обычного пользователя с именем пользователя и паролем, ProviderAttributeValue для DestinationUser должен быть именем пользователя в пуле пользователей. Для пользователя с федерацией он должен быть user_id, специфичным для поставщика.

ProviderAttributeName DestinationUser игнорируется.

ProviderName должен быть установлен на Cognito для пользователей в пулах пользователей Cognito.

Предупреждение

Все атрибуты в профиле DestinationUser должны быть изменяемыми. Если вы присвоили пользователю какие-либо неизменяемые пользовательские атрибуты, операция не будет выполнена.

ProviderName -> (строка)

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

ProviderAttributeName -> (строка)

Имя атрибута поставщика, который нужно связать, например NameID.

ProviderAttributeValue -> (строка)

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

Сокращенный синтаксис:

ProviderName=string,ProviderAttributeName=string,ProviderAttributeValue=string

Синтаксис JSON:

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

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

Учетная запись внешнего IdP для пользователя, который еще не существует в пуле пользователей. Этот пользователь должен быть пользователем с федерацией (например, пользователем SAML или Facebook), а не другим обычным пользователем.

Если SourceUser использует IdP федерации социальных сетей, например Facebook, Google или Login with Amazon, вы должны установить ProviderAttributeName на Cognito_Subject. Для социальных IdP ProviderName будет Facebook, Google или LoginWithAmazon, и Amazon Cognito автоматически разобьёт токены Facebook, Google и Login with Amazon для id, sub и user_id соответственно. ProviderAttributeValue для пользователя должен совпадать со значением id, sub или user_id, найденным в токенах социального IdP.

Для OIDC ProviderAttributeName может быть любым сопоставленным значением из утверждения в токенах доступа, или которое ваше приложение извлекает с помощью userInfo конечной точки. Для SAML ProviderAttributeName может быть любым сопоставленным значением из утверждения в SAML утверждении.

Следующие дополнительные соображения применяются к SourceUser для поставщиков OIDC и SAML.

Вы должны сопоставить утверждение с атрибутом пула пользователей в своей конфигурации IdP и установить имя атрибута пула пользователей как значение ProviderAttributeName в вашем запросе AdminLinkProviderForUser. Например, email.
Когда вы устанавливаете ProviderAttributeName на Cognito_Subject, Amazon Cognito автоматически разобьёт значение по умолчанию уникального идентификатора, найденного в предмете из токена IdP.

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
текст
таблица
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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для связи локального пользователя с пользователем с федерацией

Следующий admin-link-provider-for-user пример связывает локального пользователя diego с пользователем, который будет выполнять вход с помощью федерации с Google.

aws cognito-idp admin-link-provider-for-user \
    --user-pool-id us-west-2_EXAMPLE \
    --destination-user ProviderName=Cognito,ProviderAttributeValue=diego \
    --source-user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google

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

Вывод

Нет