View a markdown version of this page

AWS IAM Identity Center 的身份验证 OpenSearch 用户界面 - 亚马逊 OpenSearch 服务

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

AWS IAM Identity Center 的身份验证 OpenSearch 用户界面

和 AWS IAM Identity Center,您的团队将获得基于浏览器的单点登录体验。您的用户使用他们的登录 AWS IAM Identity Center 凭证,而不是生成预签名 URL。

先决条件

  • 一个 AWS 既有基础账户,又有账户 AWS IAM Identity Center IAM 权限。有关所需权限的更多信息,请参阅 的 IAM 政策参考 OpenSearch 用户界面。

  • AWS IAM Identity Center 已在您的账户或组织中启用。注意您有组织实例还是账户实例,因为这会影响某些配置步骤。

  • 具有所需权限策略和信任策略的 IAM 角色。你在中创建这个角色 步骤 2:创建 IAM 角色。

  • 至少一个 OpenSearch 中的域或无服务器集合 AWS 地区。

  • 中创建了至少一个用户或群组 AWS IAM Identity Center。

使用客户管理密钥的组织实例的额外先决条件

如果你的组织实例是 AWS IAM Identity Center 使用客户管理的密钥进行静态加密,您必须授权 OpenSearch 使用该密钥解密身份数据的 UI 权限。没有此权限,单点登录将失败 AccessDeniedException 然而 OpenSearch UI 验证授权码。

要检查您的实例是否使用客户管理的密钥,请打开 AWS IAM Identity Center 控制台,选择 设置,选择 管理 选项卡,然后查看 用于加密 IAM 身份中心静态数据的密钥。如果它显示的是客户管理的密钥 ARN 而不是 AWS 拥有的密钥,将以下语句添加到管理账户的密钥策略中 AWS IAM Identity Center 已启用。替换 organization-id 和你的 AWS 组织组织 ID,格式为 o-xxxxxxxxxx。

{ "Sid": "Allow_AWS_app_admins_in_the_same_AWS_organization_to_use_the_KMS_key", "Effect": "Allow", "Principal": "*", "Action": [ "kms:Decrypt" ], "Resource": "*", "Condition": { "StringEquals": { "aws:PrincipalOrgID": "{{organization-id}}" }, "StringLike": { "kms:ViaService": [ "sso.*.amazonaws.com", "identitystore.*.amazonaws.com" ] } } }, { "Sid": "Allow_managed_apps_to_use_the_KMS_Key", "Effect": "Allow", "Principal": "*", "Action": [ "kms:Decrypt" ], "Resource": "*", "Condition": { "Bool": { "aws:PrincipalIsAWSService": "true" }, "StringLike": { "kms:ViaService": [ "sso.*.amazonaws.com", "identitystore.*.amazonaws.com" ] }, "StringEquals": { "aws:SourceOrgID": "{{organization-id}}" } } }

有关更多信息,请参阅 客户管理的密钥 在 AWS IAM Identity Center 用户指南。

第 1 步:验证这一点 AWS IAM Identity Center 已启用

为了验证这一点 AWS IAM Identity Center 已启用
  1. 打开 AWS IAM Identity Center 控制台。

  2. 如果控制台显示包含您的实例详细信息的仪表板, AWS IAM Identity Center 已启用。注意该实例是组织实例还是账户实例。

  3. 如果控制台显示设置页面,请启用 AWS IAM Identity Center 在你继续之前。

组织实例适用于您的所有账户 AWS 组织机构,建议将其用于生产用途。账户实例的范围限定为单个账户,适合测试和隔离设置。如果您的账户属于其他人管理的组织,请询问您的管理员是否 AWS IAM Identity Center 必须在组织级别启用。

步骤 2:创建 IAM 角色

AWS IAM Identity Center 当用户访问您的 IAM 角色时 OpenSearch 用户界面应用程序。该角色需要权限策略(定义角色可以做什么)和信任策略(定义谁可以代入该角色)。

使用以下权限策略。将占位符值 替换为您自己的信息。

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "opensearch:ApplicationAccessAll", "Resource": "arn:aws:opensearch:{{region}}:{{account-id}}:application/*" } ] }

使用以下信任策略,这允许 AWS IAM Identity Center 要扮演这个角色:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "sso.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

要创建角色并将权限策略附加到 AWS CLI,运行以下命令:

aws iam create-role \ --role-name OpenSearchUI-IDC-Role \ --assume-role-policy-document '{ "Version":"2012-10-17", "Statement":[{ "Effect":"Allow", "Principal":{"Service":"sso.amazonaws.com"}, "Action":"sts:AssumeRole" }] }' aws iam put-role-policy \ --role-name OpenSearchUI-IDC-Role \ --policy-name OpenSearchAppAccess \ --policy-document '{ "Version":"2012-10-17", "Statement":[{ "Effect":"Allow", "Action":"opensearch:ApplicationAccessAll", "Resource":"arn:aws:opensearch:{{region}}:{{account-id}}:application/*" }] }'

记下 角色 ARN。你可以在下一步中指定它。此 ARN 的格式为:arn:aws:iam::{{account-id}}:role/OpenSearchUI-IDC-Role。

步骤 3:使用创建应用程序 AWS IAM Identity Center 已启用

开始创建应用程序
  1. 打开 亚马逊 OpenSearch 服务控制台。

  2. 在导航菜单上,选择 OpenSearch 用户界面(仪表板)。

  3. 选择创建应用程序。

  4. 输入应用程序的名称。

  5. 添加至少一个数据源,要么是 OpenSearch 域名或无服务器集合。

继续使用相同的表单开启单点登录并完成应用程序的创建。

启用 AWS IAM Identity Center 并创建应用程序
  1. 选择 使用 IAM 身份中心进行身份验证 复选框。

  2. 选择您在中创建的 IAM 角色 步骤 2:创建 IAM 角色。

  3. (可选)配置仪表板管理员。

  4. 选择创建。

要使用创建相同的应用程序 AWS CLI,运行以下命令。将占位符值 替换为您自己的信息。

aws opensearch create-application \ --name "{{application-name}}" \ --iam-identity-center-options '{ "enabled": true, "iamRoleForIdentityCenterApplicationArn": "arn:aws:iam::{{account-id}}:role/OpenSearchUI-IDC-Role" }' \ --data-sources '[{ "dataSourceArn": "arn:aws:es:{{region}}:{{account-id}}:domain/{{domain-name}}" }]' \ --region {{region}}

步骤 4:在中分配用户 AWS IAM Identity Center

为应用程序分配用户或群组
  1. 打开 AWS IAM Identity Center 控制台。

  2. 在导航菜单上,选择 应用程序。

  3. 选择符合以下条件的应用程序 OpenSearch 用户界面自动注册。它的名字和你的一致 OpenSearch UI 应用程序名称。

  4. 选择分配用户和组。

  5. 选择需要访问的用户或群组,然后选择 分配。

步骤 5:验证设置

验证设置
  1. 在亚马逊 OpenSearch 服务控制台,确认应用程序状态为 活跃,这表示该应用程序已准备就绪,可以使用。

  2. 确认一下 使用 IAM 身份中心进行身份验证 在应用程序详细信息页面上启用。

  3. 从应用程序详细信息页面复制应用程序 URL。

  4. 在浏览器中打开应用程序 URL。你被重定向到 AWS IAM Identity Center 登录页面。

  5. 使用您的账号登录 AWS IAM Identity Center 证书。这个 OpenSearch 将出现 UI 工作空间选择器。

以编程方式管理用户和群组

当你创建一个 OpenSearch 带有 UI 的应用程序 AWS IAM Identity Center 已启用, OpenSearch UI 注册了一个 AWS IAM Identity Center 应用程序。必须将用户分配到该应用程序,然后他们才能登录。有两个不同的访问级别:

应用程序分配

控制谁可以登录 OpenSearch 用户界面。你可以用它来管理 sso-admin 命令。

应用程序管理员

控制谁可以编辑或删除应用程序并管理其工作区。你可以用它来管理 aws opensearch update-application。有关应用程序管理员的更多信息,请参见 管理应用程序管理员。

在管理任务之前,您需要三个标识符。

标识符 如何获得
这个 AWS IAM Identity Center 应用程序 ARN aws opensearch get-application,在 iamIdentityCenterOptions.iamIdentityCenterApplicationArn
身份存储 ID aws sso-admin list-instances,在 Instances[0].IdentityStoreId
用户或群组 ID aws identitystore list-users 或 aws identitystore list-groups

以下命令按用户名查找用户,并按其显示名称查找群组。替换 placeholder values 用你自己的信息:

aws identitystore list-users \ --identity-store-id {{identity-store-id}} \ --filters '[{"AttributePath":"UserName","AttributeValue":"{{user-name}}"}]' \ --region {{region}} \ --query 'Users[0].UserId' --output text aws identitystore list-groups \ --identity-store-id {{identity-store-id}} \ --filters '[{"AttributePath":"DisplayName","AttributeValue":"{{group-name}}"}]' \ --region {{region}} \ --query 'Groups[0].GroupId' --output text

以下命令将用户或组分配给应用程序,并查看或删除任务。对于群组,设置 --principal-type 到 GROUP 并使用您之前找到的群组 ID 作为主体 ID:

aws sso-admin create-application-assignment \ --application-arn {{identity-center-application-arn}} \ --principal-id {{principal-id}} \ --principal-type USER \ --region {{region}} aws sso-admin list-application-assignments \ --application-arn {{identity-center-application-arn}} \ --region {{region}} aws sso-admin delete-application-assignment \ --application-arn {{identity-center-application-arn}} \ --principal-id {{principal-id}} \ --principal-type USER \ --region {{region}}

如果您的身份存储中尚不存在用户或群组,请使用创建该用户或群组 aws identitystore create-user 要么 aws identitystore create-group,然后使用添加成员 aws identitystore create-group-membership。

以下 Python 代码示例按用户名查找用户,并将该用户分配给具有的应用程序 AWS 适用于 Python 的 SDK (Boto3):

import boto3 region = "{{region}}" app_id = "{{application-id}}" opensearch = boto3.client("opensearch", region_name=region) sso_admin = boto3.client("sso-admin", region_name=region) identity_store = boto3.client("identitystore", region_name=region) app = opensearch.get_application(id=app_id) idc_app_arn = app["iamIdentityCenterOptions"]["iamIdentityCenterApplicationArn"] identity_store_id = sso_admin.list_instances()["Instances"][0]["IdentityStoreId"] users = identity_store.list_users( IdentityStoreId=identity_store_id, Filters=[{"AttributePath": "UserName", "AttributeValue": "{{user-name}}"}], ) user_id = users["Users"][0]["UserId"] sso_admin.create_application_assignment( ApplicationArn=idc_app_arn, PrincipalId=user_id, PrincipalType="USER", )

故障排除 AWS IAM Identity Center 身份验证

AWS IAM Identity Center 身份验证问题通常来自忽略的信任策略 sso.amazonaws.com、缺少所需操作的权限策略,或未分配给应用程序的用户。下表列出了常见症状、可能的原因以及每种症状的解决方法。

症状 可能原因 解决方案
一条消息是 AWS IAM Identity Center 创建应用程序时会显示未启用 您的账户或组织中没有实例 启用 AWS IAM Identity Center 在 AWS IAM Identity Center 控制台
单点登录重定向但返回错误 角色信任策略不包括 sso.amazonaws.com 按照中所述更新信任政策 步骤 2:创建 IAM 角色
Sign-in 成功但用户没有访问权限 用户未分配到应用程序 将用户分配到 AWS IAM Identity Center 控制台,如中所述 步骤 4:在中分配用户 AWS IAM Identity Center
登录后访问被拒绝 角色权限策略缺少必需的操作 确认该角色具有 opensearch:ApplicationAccessAll 和访问数据源的权限
该应用程序显示 AWS IAM Identity Center 已启用,但登录失败 角色 ARN 不匹配 确认应用程序设置中的角色 ARN 是具有正确信任和权限策略的角色
无法使用创建应用程序 AWS IAM Identity Center AWS IAM Identity Center 权限缺失 确认您的 IAM 委托人已经 sso:CreateApplication, sso:PutApplicationGrant,以及 iam:PassRole
出现登录页面,但没有用户可以登录 未分配任何用户 AWS IAM Identity Center 将用户分配到应用程序 AWS IAM Identity Center 控制台
Sign-in 失败,显示无法验证授权码的消息,或者 AccessDeniedException AWS IAM Identity Center 使用客户管理的密钥而没有所需的密钥策略 添加本主题前面描述的关键政策声明
用户在被分配后不久无法登录 任务尚未传播 等待一到两分钟,然后重试
create-application-assignment 上的 AccessDeniedException 这个 sso:CreateApplicationAssignment 权限缺失 添加 AWS IAM Identity Center 中列出的权限 的 IAM 政策参考 OpenSearch 用户界面
ConflictException 在一项任务中 用户或组已分配 使用以下方式确认 list-application-assignments