API 資格情報と製品プロファイル管理
OpenAPI ベースの AEM API の 資格情報と製品プロファイル を管理する方法を学びます。
このチュートリアルでは、次を追加または削除する方法を学びます。
- 資格情報:AEM API の認証を提供します。
- 製品プロファイル:AEM リソースにアクセスするための資格情報に対する権限(または承認)を提供します。
背景
AEM API を使用する場合は、Adobe Developer Console(または ADC)プロジェクトで 資格情報 と 製品プロファイル を定義する必要があります。次のスクリーンショットでは、AEM Assets Author API の 資格情報 と 製品プロファイル を確認できます。
資格情報は、API の認証メカニズムを提供します。製品プロファイルは、資格情報に 権限(または承認) を付与し、AEM リソースへのアクセスを提供します。API リクエストは、アプリケーションまたはユーザーの代わりに行うことができます。
製品プロファイルは、1 つ以上の サービス に関連付けられています。AEM as a Cloud Service では、サービスは、リポジトリノード用に事前定義されたアクセス制御リスト(ACL)を持つユーザーグループを表し、細かい権限管理を可能にします。
API が正常に呼び出されると、製品プロファイルおよびサービス設定に一致するユーザーグループと共に、ADC プロジェクトの資格情報を表すユーザーが AEM オーサーサービスに作成されます。
上記のシナリオでは、ユーザー 1323d2... は AEM オーサーサービスで作成され、ユーザーグループ AEM Assets Collaborator Users - Service と AEM Assets Collaborator Users - author - Program XXX - Environment XXX のメンバーです。
資格情報の追加または削除
AEM API は、認証用に次のタイプの資格情報をサポートしています。
- OAuth サーバー間:マシン間インタラクション用に設計されています。
- OAuth web アプリ:クライアントアプリケーションでのバックエンドサーバーとのユーザー主導のインタラクション用に設計されています。
- OAuth 単一ページアプリ:クライアントアプリケーションでのバックエンドサーバーを使用しないユーザー主導のインタラクション用に設計されています。
様々なタイプの資格情報を使用して、様々なユースケースをサポートできます。
すべての資格情報は、ADC プロジェクトで管理されます。
AEM API の資格情報を追加するには、ADC プロジェクトの「API」セクションに移動し、「別の資格情報を接続」をクリックします。次に、特定の資格情報タイプ用の手順に従います。
AEM API 資格情報を削除するには、ADC プロジェクトの「API」セクションで資格情報を選択してから、「資格情報の削除」をクリックします。
製品プロファイルの追加または削除
製品プロファイルは、AEM リソースにアクセスするための資格情報への 権限(または承認) を提供します。製品プロファイルが提供する権限は、製品プロファイルに関連付けられた サービス に基づいています。ほとんどの サービス は、サービスと同じ名前を持つ AEM インスタンスのユーザーグループを介して、AEM リソースに 読み取り 権限を提供します。
資格情報(別名テクニカルアカウントユーザー)には、AEM リソースの作成、更新、削除(CUD)などの追加の権限が必要な場合があります。その場合、必要な権限を提供する サービス に関連付けられた新しい 製品プロファイル を追加する必要があります。
例えば、AEM Assets Author API の呼び出しで GET 以外のリクエストに対して 403 エラーが発生した場合は、AEM 管理者 - オーサー - プログラム XXX - 環境 XXX 製品プロファイルを追加して問題を解決できます。
AEM API の製品プロファイルを追加するには、ADC プロジェクトの「API」セクションの「製品プロファイルを編集」をクリックし、API の設定ダイアログで目的の製品プロファイルを選択して、変更内容を保存します。
必要なサービスに関連付ける目的の製品プロファイル(例:AEM 管理者 - オーサー - プログラム XXX - 環境 XXX)を選択してから、変更内容を保存します。
AEM 管理者 - オーサー - プログラム XXX - 環境 XXX 製品プロファイルは、AEM 管理者サービスと AEM Assets API ユーザーサービスの両方に関連付けられています。後者がない場合、製品プロファイルは使用可能な製品プロファイルのリストに表示されません。
アセットのメタデータを更新する PATCH リクエストが問題なく機能するようになりました。
AEM API の製品プロファイルを削除するには、ADC プロジェクトの「API」セクションの「製品プロファイルを編集」をクリックし、API の設定ダイアログで目的の製品プロファイルの選択を解除して、変更内容を保存します。
概要
Adobe Developer Console(ADC)プロジェクトで 資格情報と製品プロファイル を使用して、AEM API の認証メカニズムと権限を変更する方法を学びました。