create-identity-source

Description

Добавляет источник идентификации в хранилище политик — пул пользователей Amazon Cognito или поставщик удостоверений (IdP) OpenID Connect (OIDC).

После создания источника идентификации можно использовать удостоверения, предоставленные IdP, в качестве прокси для субъекта в запросах авторизации, использующих операции API IsAuthorizedWithToken или BatchIsAuthorizedWithToken. Эти удостоверения принимают форму токенов, содержащих утверждения о пользователе, такие как идентификаторы, атрибуты и членство в группе. Источники идентификации предоставляют токены идентификации (ID) и токены доступа. Verified Permissions получает информацию о вашем пользователе и сеансе из утверждений токенов. Токены доступа предоставляют действие context к вашим политикам, а токены ID предоставляют основной Attributes.

См. также: AWS API Documentation

Synopsis

  create-identity-source
[--client-token <value>]
--policy-store-id <value>
--configuration <value>
[--principal-entity-type <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]

Options

--client-token (string)

--policy-store-id (string)

--configuration (tagged union structure)

JSON Syntax:

{
  "cognitoUserPoolConfiguration": {
    "userPoolArn": "string",
    "clientIds": ["string", ...],
    "groupConfiguration": {
      "groupEntityType": "string"
    }
  },
  "openIdConnectConfiguration": {
    "issuer": "string",
    "entityIdPrefix": "string",
    "groupConfiguration": {
      "groupClaim": "string",
      "groupEntityType": "string"
    },
    "tokenSelection": {
      "accessTokenOnly": {
        "principalIdClaim": "string",
        "audiences": ["string", ...]
      },
      "identityTokenOnly": {
        "principalIdClaim": "string",
        "clientIds": ["string", ...]
      }
    }
  }
}

--principal-entity-type (string)

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

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

Глобальные опции

--debug (boolean)

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

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки config/env.

--version (string)

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

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию — 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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Чтобы создать источник идентификации

Следующий пример create-identity-source создает источник идентификации, который позволяет ссылаться на удостоверения, хранящиеся в указанном пуле пользователей Amazon Cognito. Эти удостоверения доступны в Verified Permissions как сущности типа User.

aws verifiedpermissions create-identity-source \
    --configuration file://config.txt \
    --principal-entity-type "User" \
    --policy-store-id PSEXAMPLEabcdefg111111

Содержимое config.txt:

{
    "cognitoUserPoolConfiguration": {
        "userPoolArn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_1a2b3c4d5",
        "clientIds":["a1b2c3d4e5f6g7h8i9j0kalbmc"]
    }
}

Вывод:

{
    "createdDate": "2023-05-19T20:30:28.214829+00:00",
    "identitySourceId": "ISEXAMPLEabcdefg111111",
    "lastUpdatedDate": "2023-05-19T20:30:28.214829+00:00",
    "policyStoreId": "PSEXAMPLEabcdefg111111"
}

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

Вывод

createdDate -> (timestamp)

identitySourceId -> (string)

lastUpdatedDate -> (timestamp)

policyStoreId -> (string)