アカウントユーザーとロールのAPI
アプリケーションメニューから アカウントユーザー と アカウントロール を管理することができますが、LiferayのREST APIを利用することもできます。 これらのサービスを呼び出して、アカウントユーザーとロールの作成と管理を行います。
アカウントユーザーの追加
新しいLiferay DXPインスタンスを起動し、以下を実行します。
メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
次に、以下の手順を実行します。
-
Accounts API Basics をダウンロードし、解凍します。
-
アカウントIDの一覧を取得するには、 Accounts_GET_FromInstance リソースを使用します。 ユーザーを追加したいアカウントIDをメモしてください。
-
cURLスクリプトを使用して、新しいアカウントユーザーをアカウントに追加します。 コマンドラインで、
curl
フォルダに移動します。 アカウントIDをパラメータとして、AccountUser_POST_ToAccount.sh
スクリプトを実行します。JSONのレスポンスには、新しいアカウントが追加されたことが示されています。
-
グローバルメニュー → [アプリケーション] → [Accounts] に移動します。 ユーザーを作成したアカウントをクリックします。 [Users] タブをクリックすると、作成された新しいユーザーが表示されます。
-
RESTサービスは、Javaクライアントを使って呼び出すこともできます。
curl
フォルダから、java
フォルダに移動します。 以下のコマンドでソースファイルをコンパイルします。 -
AccountUser_POST_ToAccount.java
クラスを以下のコマンドで実行します。1234
をアカウントのIDに置き換えてください。
cURLコマンドの検証
AccountUser_POST_ToAccount.sh
スクリプトは、cURLコマンドでRESTサービスを呼び出します。
コマンドの引数は次のとおりです。
引数 | 説明 |
---|---|
-H "Content-Type: application/json" | リクエストボディのフォーマットがJSONであることを示します。 |
-X POST | 指定されたエンドポイントで起動するHTTPメソッド |
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/user-accounts" | RESTサービスのエンドポイント |
-d "{\"alternateName\": \"Dog\", \"emailAddress\": \"dog@liferay.com\", \"familyName\": \"Easy\", \"givenName\": \"Dog\"}" | お客様が掲載を希望するデータ |
-u "test@liferay.com:learn" | 基本的な認証情報 |
ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth2 を使ってユーザーを認証する必要があります。 OAuth2を利用したReactアプリケーションのサンプルは、OAuth2を利用したユーザー認証 をご参照ください。
他のcURLコマンドも同様のJSON引数を使用します。
Javaクラスを調べる
Account_POST_ToInstance.java
クラスは、関連するサービスを呼び出して、アカウントユーザーを追加します。
このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。
行(省略形) | 説明 |
---|---|
UserAccountResource.Builder builder = ... | UserAccountResource サービスインスタンスを生成するためのBuilder を取得します。 |
UserAccountResource userAccountResource = builder.authentication(...).build(); | ベーシック認証を指定し、 UserAccountResource サービスインスタンスを生成します。 |
UserAccount userAccount = userAccountResource.postAccountUserAccount(...); | userAccountResource.postAccountUserAccount メソッドを呼び出し、データをpostに渡します。 |
プロジェクトには、依存関係としてcom.liferay.headless.admin.user.client.jar
ファイルが含まれていることに注意してください。 すべてのRESTアプリケーションのクライアントJAR依存関係情報は、/o/api
でインストール先のAPIエクスプローラーで確認できます。
main
メソッドのコメントでは、クラスの実行を実演しています。
他のJavaクラスの例は、このクラスと似ていますが、異なるメソッドを呼び出しています。
サービスの詳細は、 AccountResource を参照してください。
以下は、cURLとJavaを使って、関連する他のRESTサービスを呼び出す例です。
アカウントからアカウントユーザーを取得
以下のcURLまたはJavaコマンドを実行すると、アカウントのユーザーを一覧表示できます。 上記と同様に、 1234
をアカウントのIDに置き換えてください。
AccountUsers_GET_FromAccount.sh
コマンド:
コード:
AccountUsers_GET_FromAccount.java
コマンド:
コード:
アカウントの UserAccountの
オブジェクトがJSONで表示されます。
アカウントロールの投稿
特定のアカウントに対して新しいアカウントロールを作成します。 なお、 1234
は、アカウントのIDに置き換えてください。
AccountRole_POST_ToAccount.sh
コマンド:
コード:
AccountRole_POST_ToAccount.java
コマンド:
コード:
ユーザーをアカウントロールに関連付ける
ユーザーを特定のアカウントロールに関連付けることができます。 1234
をアカウントのIDに置き換えてください。 お使いのアカウントのロールのIDを5678
に置き換えます。 9012
は、アカウントユーザーのIDに置き換えてください。
AccountRole_POST_UserAssociation.sh
コマンド:
コード:
AccountRole_POST_UserAssociation.java
コマンド:
コード:
アカウントからのアカウントロールの取得
以下のcURLまたはJavaコマンドを実行することで、アカウントのアカウントロールを一覧表示することができます。 1234
をアカウントのIDに置き換えてください。
AccountRoles_GET_FromAccount.sh
コマンド:
コード:
AccountRoles_GET_FromAccount.java
コマンド:
コード:
アカウントの AccountRoleの
オブジェクトがJSONで表示されます。
アカウントロール・ユーザー・アソシエーションの削除
特定のアカウントユーザーからアカウントロールの関連付けを削除します。 1234
をアカウントのIDに置き換えてください。 お使いのアカウントのロールのIDを5678
に置き換えます。 9012
は、アカウントユーザーのIDに置き換えてください。
AccountRole_DELETE_UserAssociation.sh
コマンド:
コード:
AccountRole_DELETE_UserAssociation.java
コマンド
コード:
APIエクスプローラーには、アカウント
のすべてのサービスとスキーマが一覧表示され、各サービスを試すためのインターフェースがあります。