API 資格情報と製品プロファイル管理
- トピック:
- 開発
作成対象:
- 初心者
- 開発者
- リーダー
OpenAPI ベースのAEM API の 資格情報と製品プロファイル を管理する方法について説明します。
このチュートリアルでは、以下を追加または削除する方法を学びます。
- 資格情報:AEM API の認証を指定します。
- 製品プロファイル:AEM リソースにアクセスするための資格情報に対する権限(または認証)を提供します。
背景
AEM API を使用する場合は、Adobe Developer Console(または ADC)プロジェクトで 資格情報 と 製品プロファイル を定義する必要があります。 次のスクリーンショットでは、AEM Assets オーサー 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 オーサー API の呼び出しでGET以外のリクエストに対して 403 エラーが発生した場合は、AEM管理者 – オーサー – プログラム XXX – 環境 XXX 製品プロファイル を追加して問題を解決できます。
AEM API の製品プロファイルを追加するには、ADC プロジェクトの API セクションの 製品プロファイルを編集 をクリックし、Configure API ダイアログで目的の製品プロファイルを選択して、変更内容を保存します。
![ 製品プロファイルを編集 ] (../assets/how-to/edit-product-profiles.png)
必要なサービスに関連付ける目的の製品プロファイル (例:AEM管理者 – 作成者 – プログラム XXX – 環境 XXX)を選択し、変更内容を保存します。
![ 製品プロファイルを選択 ] (../assets/how-to/select-product-profile.png)
AEM Administrators - author - Program XXX - Environment XXX 製品プロファイルは、AEM Administrators サービスと AEM Assets API Users サービスの両方に関連付けられています。 後者がない場合、製品プロファイルは使用可能な製品プロファイルのリストに表示されません。
![ 製品プロファイルサービス ] (../assets/how-to/product-profile-services.png)
アセットのメタデータを更新する 0}PATCH} リクエストは問題なく機能するようになりました。
![PATCHのリクエスト ] (../assets/how-to/patch-request.png)

概要
Adobe Developer Console(ADC)プロジェクトで 資格情報と製品プロファイル を使用して、AEM API の認証メカニズムと権限を変更する方法を学びました。