View a markdown version of this page

AWS IAM アイデンティティセンター OpenSearch UI の認証 - Amazon OpenSearch Service

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS IAM アイデンティティセンター OpenSearch UI の認証

を使用すると AWS IAM アイデンティティセンター、チームはブラウザベースのシングルサインオンエクスペリエンスを得られます。ユーザーは、署名付き URL を生成する代わりに AWS IAM アイデンティティセンター 、認証情報を使用してサインインします。 URLs

前提条件

  • 基本アクセス許可と AWS IAM アイデンティティセンター IAM アクセス許可の両方を持つ AWS アカウント。必要なアクセス許可の詳細については、「OpenSearch UI の IAM ポリシーリファレンス」を参照してください。

  • AWS IAM アイデンティティセンター アカウントまたは組織で が有効になっています。一部の設定ステップに影響するため、組織インスタンスまたはアカウントインスタンスがあるかどうかに注意してください。

  • 必要なアクセス許可ポリシーと信頼ポリシーの両方を持つ IAM ロール。このロールは で作成しますステップ 2: IAM ロールを作成する。

  • リージョンに AWS 少なくとも 1 つの OpenSearch ドメインまたはサーバーレスコレクション。

  • 少なくとも 1 つのユーザーまたはグループが作成されました AWS IAM アイデンティティセンター。

カスタマーマネージドキーを使用する組織インスタンスの追加前提条件

の組織インスタンスが保管時の暗号化にカスタマーマネージドキー AWS IAM アイデンティティセンター を使用している場合は、OpenSearch UI にそのキーを使用して ID データを復号化するためのアクセス許可を付与する必要があります。このアクセス許可がない場合、OpenSearch UI が認可コードを検証AccessDeniedExceptionしている間、シングルサインオンは で失敗します。

インスタンスがカスタマーマネージドキーを使用しているかどうかを確認するには、コンソールを開き AWS IAM アイデンティティセンター 、設定を選択し、管理タブを選択し、保管中の IAM アイデンティティセンターデータを暗号化するためのキーを確認します。 AWS 所有キーではなくカスタマーマネージドキー ARN が表示されている場合は、 AWS IAM アイデンティティセンター が有効になっている管理アカウントのキーポリシーに次のステートメントを追加します。organization-id を Organizations 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 アイデンティティセンター ユーザーガイド」の「カスタマーマネージドキー」を参照してください。

ステップ 1: AWS IAM アイデンティティセンター が有効になっていることを確認する

AWS IAM アイデンティティセンター が有効になっていることを確認するには
  1. AWS IAM Identity Center コンソールを開きます。

  2. コンソールにインスタンスの詳細を含むダッシュボードが表示されている場合は、 が有効 AWS IAM アイデンティティセンター になります。インスタンスが組織インスタンスかアカウントインスタンスかに注意してください。

  3. コンソールにセットアップページが表示されている場合は、続行する AWS IAM アイデンティティセンター 前に を有効にします。

組織インスタンスは Organizations AWS 組織内のすべてのアカウントで動作するため、本番環境での使用をお勧めします。アカウントインスタンスは、テストと分離されたセットアップに適した単一のアカウントに限定されます。アカウントが他の誰かが管理する組織に属している場合は、組織レベルで を有効にする AWS IAM アイデンティティセンター 必要があるかどうかを管理者に確認してください。

ステップ 2: IAM ロールを作成する

AWS IAM アイデンティティセンター は、ユーザーが OpenSearch UI アプリケーションにアクセスするときに IAM ロールを引き受けます。このロールには、ロールが実行できる操作を定義するアクセス許可ポリシーと、ロールを引き受けるユーザーを定義する信頼ポリシーが必要です。

次のアクセス許可ポリシーを使用します。プレースホルダー値を、ユーザー自身の情報に置き換えます。

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

次の信頼ポリシーを使用して、 がロールを引き受け AWS IAM アイデンティティセンター ることを許可します。

{ "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 アイデンティティセンター を有効にしてアプリケーションを作成する

アプリケーションの作成を開始するには
  1. Amazon OpenSearch Service コンソールを開きます。

  2. ナビゲーションメニューで、OpenSearch UI (ダッシュボード) を選択します。

  3. [アプリケーションを作成] を選択します。

  4. アプリケーションの名前を入力します。

  5. OpenSearch ドメインまたはサーバーレスコレクションのいずれかの少なくとも 1 つのデータソースを追加します。

同じ形式で続行してシングルサインオンを有効にし、アプリケーションの作成を完了します。

アプリケーションを有効に AWS IAM アイデンティティセンター して作成するには
  1. IAM Identity Center による認証チェックボックスをオンにします。

  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 アイデンティティセンター

ユーザーまたはグループをアプリケーションに割り当てるには
  1. AWS IAM Identity Center コンソールを開きます。

  2. ナビゲーションメニューで、アプリケーションを選択します。

  3. OpenSearch UI が自動的に登録したアプリケーションを選択します。その名前は OpenSearch UI アプリケーション名と一致します。

  4. [ユーザーとグループの割り当て] を選択します。

  5. アクセスが必要なユーザーまたはグループを選択し、割り当てを選択します。

ステップ 5: セットアップを確認する

セットアップを確認するには
  1. Amazon OpenSearch Service コンソールで、アプリケーションのステータスがアクティブであることを確認します。これは、アプリケーションが使用できる状態であることを示します。

  2. アプリケーションの詳細ページで IAM Identity Center による認証が有効になっていることを確認します。

  3. アプリケーションの詳細ページからアプリケーション URL をコピーします。

  4. ブラウザでアプリケーション URL を開きます。サインインページに AWS IAM アイデンティティセンター リダイレクトされます。

  5. AWS IAM アイデンティティセンター 認証情報を使用してサインインします。OpenSearch UI ワークスペースセレクタが表示されます。

ユーザーとグループのプログラムによる管理

AWS IAM アイデンティティセンター を有効にして OpenSearch UI アプリケーションを作成すると、OpenSearch UI は AWS IAM アイデンティティセンター アプリケーションを登録します。サインインする前に、そのアプリケーションにユーザーを割り当てる必要があります。アクセスには 2 つの異なるレベルがあります。

アプリケーションの割り当て

OpenSearch UI にサインインできるユーザーを制御します。sso-admin コマンドを使用して管理します。

アプリケーション管理者

アプリケーションを編集または削除し、ワークスペースを管理できるユーザーを制御します。で管理しますaws opensearch update-application。アプリケーション管理者の詳細については、「」を参照してくださいアプリケーション管理者の管理。

割り当てを管理する前に、3 つの識別子が必要です。

識別子 取得方法
AWS IAM アイデンティティセンター アプリケーション ARN aws opensearch get-application、 で iamIdentityCenterOptions.iamIdentityCenterApplicationArn
ID ストア ID aws sso-admin list-instances、 で Instances[0].IdentityStoreId
ユーザーまたはグループ ID aws identitystore list-users、または aws identitystore list-groups

次のコマンドは、ユーザー名でユーザーを検索し、表示名でグループを検索します。プレースホルダー値は、ユーザー自身の情報に置き換えてください。

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}}

ユーザーまたはグループが ID ストアにまだ存在しない場合は、 aws identitystore create-userまたは で作成しaws identitystore create-group、 でメンバーを追加しますaws identitystore create-group-membership。

次の Python コード例では、ユーザー名でユーザーを検索し、 AWS SDK for Python (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 アイデンティティセンター 認証のトラブルシューティング

AWS IAM アイデンティティセンター 認証の問題は通常、 を省略する信頼ポリシーsso.amazonaws.com、必要なアクションがないアクセス許可ポリシー、またはアプリケーションに割り当てられていないユーザーから発生します。次の表に、一般的な症状、考えられる原因、それぞれの解決方法を示します。

症状 考えられる原因 解決策
アプリケーションの作成中に AWS IAM アイデンティティセンター 、有効になっていないメッセージが表示されます。 アカウントまたは組織にインスタンスがない AWS IAM アイデンティティセンター コンソール AWS IAM アイデンティティセンター で を有効にする
シングルサインオンはリダイレクトしますが、エラーを返します ロールの信頼ポリシーには は含まれません sso.amazonaws.com 「」の説明に従って信頼ポリシーを更新する ステップ 2: IAM ロールを作成する
サインインは成功したが、ユーザーにアクセスできない ユーザーがアプリケーションに割り当てられていない 「」で説明されているように、 AWS IAM アイデンティティセンター コンソールでユーザーを割り当てる ステップ 4: でユーザーを割り当てる AWS IAM アイデンティティセンター
サインイン後にアクセスが拒否される ロールのアクセス許可ポリシーに必要なアクションがありません ロールにデータソースへのアクセス許可opensearch:ApplicationAccessAllとアクセス許可があることを確認します。
アプリケーションは有効 AWS IAM アイデンティティセンター と表示されますが、サインインは失敗します ロール ARN が一致しません アプリケーション設定のロール ARN が正しい信頼ポリシーとアクセス許可ポリシーを持つロールであることを確認します。
アプリケーションは で作成できません AWS IAM アイデンティティセンター AWS IAM アイデンティティセンター アクセス許可がありません IAM プリンシパルに sso:CreateApplication、sso:PutApplicationGrant、および があることを確認します。 iam:PassRole
サインインページが表示されますが、ユーザーはサインインできません にユーザーが割り当てられていない AWS IAM アイデンティティセンター AWS IAM アイデンティティセンター コンソールでユーザーをアプリケーションに割り当てる
サインインが失敗し、認可コードを検証できないというメッセージが表示されるか、 AccessDeniedException AWS IAM アイデンティティセンター 必要なキーポリシーなしでカスタマーマネージドキーを使用する このトピックで前述したキーポリシーステートメントを追加する
ユーザーが割り当てられた後すぐにサインインできない 割り当てはまだ反映されていません 1~2 分待ってから、もう一度試してください
create-application-assignment での AccessDeniedException アクセスsso:CreateApplicationAssignment許可がありません にリストされている AWS IAM アイデンティティセンター アクセス許可を追加する OpenSearch UI の IAM ポリシーリファレンス
ConflictException 割り当ての ユーザーまたはグループがすでに割り当てられている で確認 list-application-assignments