Spec-Zone.ru › AWS CLI v2

[ aws . verifiedpermissions ]

list-identity-sources

Описание

Возвращает постраничный список всех источников идентификации, определённых в указанном хранилище политик.

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

list-identity-sources это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной разметкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: identitySources

Синтаксис

  list-identity-sources
--policy-store-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--policy-store-id (строка)

Указывает ID хранилища политик, содержащего источники идентификации, которые необходимо перечислить.

--filters (список)

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

(структура)

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

Этот тип данных является параметром запроса для операции ListIdentityStores.

principalEntityType -> (строка)

Тип сущности Cedar принципалов, возвращаемых поставщиком удостоверений (IdP), связанным с этим источником идентификации.

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

principalEntityType=string ...

Синтаксис JSON:

[
  {
    "principalEntityType": "string"
  }
  ...
]

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

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

Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не следует использовать элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--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 (int)

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

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 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.

Для перечисления доступных источников идентификации

Следующий пример list-identity-sources перечисляет все источники идентификации в указанном хранилище политик.

aws verifiedpermissions list-identity-sources \
    --policy-store-id PSEXAMPLEabcdefg111111

Вывод:

{
    "identitySources": [
        {
            "createdDate": "2023-06-12T22:27:49.150035+00:00",
            "details": {
                "clientIds": [ "a1b2c3d4e5f6g7h8i9j0kalbmc" ],
                "discoveryUrl": "https://cognito-idp.us-west-2.amazonaws.com/us-west-2_1a2b3c4d5",
                "openIdIssuer": "COGNITO",
                "userPoolArn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_1a2b3c4d5"
            },
            "identitySourceId": "ISEXAMPLEabcdefg111111",
            "lastUpdatedDate": "2023-06-12T22:27:49.150035+00:00",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "principalEntityType": "User"
        }
    ]
}

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

Вывод

nextToken -> (строка)

Если присутствует, это значение указывает на то, что доступно больше вывода, чем включено в текущем ответе. Используйте это значение в параметре запроса NextToken в последующем вызове операции для получения следующей части вывода. Вы должны повторять это, пока элемент ответа NextToken не вернет значение null . Это указывает, что это последняя страница результатов.

identitySources -> (список)

Список источников идентификации, хранящихся в указанном хранилище политик.

(структура)

Структура, определяющая источник идентификации.

Этот тип данных является параметром ответа операции ListIdentitySources.

createdDate -> (метка времени)

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

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

Структура, содержащая подробные сведения об ассоциированном поставщике идентификации (IdP).

clientIds -> (список)

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

(строка)

userPoolArn -> (строка)

Пул пользователей Amazon Cognito, чьи идентификаторы доступны в этом хранилище политик Verified Permissions.

discoveryUrl -> (строка)

Известный URL, указывающий на конечную точку открытия OIDC этого пула пользователей. Это строка URL в следующем формате. Этот URL заменяет плейсхолдеры для региона Amazon Web Services и идентификатора пула пользователей соответствующими значениями для этого пула пользователей.

https://cognito-idp.*<region>* .amazonaws.com/*<user-pool-id>* /.well-known/openid-configuration

openIdIssuer -> (строка)

Строка, определяющая тип OIDC-сервиса, представленного этим источником идентификации.

В настоящее время единственно допустимое значение — cognito.

identitySourceId -> (строка)

Уникальный идентификатор источника идентификации.

lastUpdatedDate -> (метка времени)

Дата и время последнего обновления источника идентификации.

policyStoreId -> (строка)

Идентификатор хранилища политик, содержащего источник идентификации.

principalEntityType -> (строка)

Тип сущности Cedar принципалов, возвращаемых от IdP, связанного с этим источником идентификации.

configuration -> (структура помеченного объединения)

Содержит конфигурационную информацию об источнике идентификации.

Примечание

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

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

Содержит конфигурационные детали пула пользователей Amazon Cognito, которые Verified Permissions может использовать в качестве источника аутентифицированных идентификаторов в качестве сущностей. Он указывает Amazon Resource Name (ARN) пула пользователей Amazon Cognito, сущность хранилища политик, которую вы хотите назначить группам пользователей, и один или несколько идентификаторов прикладных клиентов.

Пример: "configuration":{"cognitoUserPoolConfiguration":{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}}

userPoolArn -> (строка)

Amazon Resource Name (ARN) пула пользователей Amazon Cognito, который содержит идентификаторы, подлежащие авторизации.

Пример: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

clientIds -> (список)

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

Пример: "clientIds": ["&ExampleCogClientId;"]

(строка)

issuer -> (строка)

Идентификатор OpenID Connect (OIDC) issuer пула пользователей Amazon Cognito, который содержит идентификаторы, подлежащие авторизации.

Пример: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

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

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

groupEntityType -> (строка)

Имя типа схемы сущностей, сопоставленного с группой пула пользователей. По умолчанию AWS::CognitoGroup.

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

Содержит конфигурационные детали поставщика идентификации OpenID Connect (OIDC) или источника идентификации, который Verified Permissions может использовать для генерации сущностей из аутентифицированных идентификаторов. Он указывает URL издателя, тип токена, который вы хотите использовать, и сведения о сущности хранилища политик.

Пример:"configuration":{"openIdConnectConfiguration":{"issuer":"https://auth.example.com","tokenSelection":{"accessTokenOnly":{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"}},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"}}}

issuer -> (строка)

URL издателя поставщика идентификации OIDC. Этот URL должен иметь конечную точку обнаружения OIDC в пути .well-known/openid-configuration.

entityIdPrefix -> (строка)

Описание, которое вы хотите добавить в качестве префикса к сущностям пользователей от вашего поставщика идентификации OIDC. Например, если вы установите entityIdPrefix равным MyOIDCProvider, вы можете ссылаться на принципалы в своих политиках в формате MyCorp::User::MyOIDCProvider|Carlos.

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

Требование в токенах поставщика идентификации OIDC, которое указывает на членство пользователя в группе, и тип сущности, к которому вы хотите его сопоставить. Например, этот объект может сопоставить содержимое требования groups к MyCorp::UserGroup.

groupClaim -> (строка)

Требование токена, которое Verified Permissions должно интерпретировать как членство в группе. Например, groups.

groupEntityType -> (строка)

Тип сущности хранилища политик, к которому вы хотите сопоставить требование группы пользователей. Например, MyCorp::UserGroup . Тип сущности группы — это сущность, которая может иметь сущность типа пользователя в качестве члена.

tokenSelection -> (структура помеченного объединения)

Тип токена, который вы хотите обработать от вашего поставщика идентификации OIDC. Ваше хранилище политик может обрабатывать либо идентификационные (ID) токены, либо токены доступа из данного источника идентификации OIDC.

Примечание

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

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

Конфигурация OIDC для обработки токенов доступа. Содержит допустимые требования аудитории, например, https://auth.example.com , и требование, которое вы хотите сопоставить с принципалом, например sub.

principalIdClaim -> (строка)

Требование, определяющее принципал в токенах доступа OIDC. Например, sub.

audiences -> (список)

Значения требований к токену доступа aud, которые вы хотите принять в своём хранилище политик. Например, https://myapp.example.com, https://myapp2.example.com.

(строка)

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

Конфигурация OIDC для обработки идентификационных (ID) токенов. Содержит допустимые требования к идентификатору клиента, например, 1example23456789 , и требование, которое вы хотите сопоставить с принципалом, например, sub.

principalIdClaim -> (строка)

Требование, определяющее принципал в токенах доступа OIDC. Например, sub.

clientIds -> (список)

Значения требований к аудитории токена идентификации, или идентификаторы клиента, которые вы хотите принять в своём хранилище политик от поставщика идентификации OIDC. Например, 1example23456789, 2example10111213.

(строка)

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

Spec-Zone.ru

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