アカウントユーザーとロールのAPI¶
アプリケーションメニューから アカウントユーザー と アカウントロール を管理することができますが、LiferayのREST APIを利用することもできます。 これらのサービスを呼び出して、アカウントユーザーとRolesの作成と管理を行います。
アカウントユーザーの追加¶
新しいLiferayインスタンスを実行します。
docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u22
http://localhost:8080
でLiferayにサインインします。メールアドレスtest@liferay.comとパスワードtestを使用してください。プロンプトが表示されたら、パスワードをlearnに変更します。
次に、以下の手順を実行します。
ダウンロードして解凍する Accounts API Basics 。
curl https://learn.liferay.com/dxp/latest/ja/users-and-permissions/developer-guide/liferay-t5p9.zip -O
unzip liferay-t5p9.zip
アカウントIDの一覧を取得するには、 Accounts_GET_FromInstance リソースを使用します。 ユーザーを追加したいアカウントIDをメモしてください。
cURLスクリプトを使用して、新しいアカウントユーザーをアカウントに追加します。 コマンドラインで、
curl
フォルダに移動します。 アカウントIDをパラメータとして、AccountUser_POST_ToAccount.sh
スクリプトを実行します。./AccountUser **POST** ToAccount.sh 1234
JSONのレスポンスには、新しいアカウントが追加されたことが示されています。
{ "accountBriefs" : [ { "id" : 38935, "name" : "Able", "roleBriefs" : [ ] } ], "additionalName" : "", "alternateName" : "dog", "birthDate" : "1977-01-01T00:00:00Z", "customFields" : [ ], "dashboardURL" : "", "dateCreated" : "2021-10-12T21:00:59Z", "dateModified" : "2021-10-12T21:01:01Z", "emailAddress" : "[email protected]", "externalReferenceCode" : "", "familyName" : "Easy", "givenName" : "Dog", "id" : 39005, "jobTitle" : "", "keywords" : [ ], "name" : "Dog Easy", "organizationBriefs" : [ ], "profileURL" : "", "roleBriefs" : [ { "id" : 20111, "name" : "User" } ], "siteBriefs" : [ { "id" : 20125, "name" : "Global" }, { "id" : 20123, "name" : "Guest" } ], "userAccountContactInformation" : { "emailAddresses" : [ ], "facebook" : "", "jabber" : "", "postalAddresses" : [ ], "skype" : "", "sms" : "", "telephones" : [ ], "twitter" : "", "webUrls" : [ ] } }
グローバルメニュー → アプリケーション → アカウント に移動します。 ユーザーを作成したアカウントをクリックします。 Users タブをクリックすると、作成された新しいUserが表示されます。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。
curl
フォルダから、java
フォルダに移動します。 以下のコマンドでソースファイルをコンパイルします。javac -classpath .: *** .java
AccountUser_POST_ToAccount.java
クラスを以下のコマンドで実行します。1234
をアカウントのIDに置き換えてください。java -classpath .: **-DaccountId=1234 AccountUser***POST** ToAccount
cURLコマンドの検証¶
AccountUser_POST_ToAccount.sh
スクリプトは、cURLコマンドでRESTサービスを呼び出します。
curl \
-H "Content-Type: application/json" \
-X POST \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/user-accounts" \
-d "{\"alternateName\": \"Dog\", \"emailAddress\": \"[email protected]\", \"familyName\": \"Easy\", \"givenName\": \"Dog\"}" \
-u "[email protected]:learn"
ここでは、コマンドの引数を紹介します。
引数 |
説明 |
---|---|
|
リクエストボディのフォーマットがJSONであることを示します。 |
|
指定されたエンドポイントで起動するHTTPメソッド |
|
RESTサービスのエンドポイント |
|
お客様が掲載を希望するデータ |
|
基本的な認証情報 |
注釈
ここでは、デモのためにベーシック認証を使用しています。 本番環境では、 OAuth2でユーザーを認証する必要があります。
他のcURLコマンドも同様のJSON引数を使用しています。
Javaクラスを調べる¶
Account_POST_ToInstance.java
クラスは、関連するサービスを呼び出して、アカウントユーザーを追加します。
public static void main(String[] args) throws Exception {
AccountResource.Builder builder = AccountResource.builder();
AccountResource accountResource = builder.authentication(
"[email protected]", "learn"
).build();
Account account = accountResource.postAccount(
new Account() {
{
description = "Foo";
name = "Fox";
}
});
System.out.println(account);
}
このクラスは、わずか3行のコードでRESTサービスを呼び出します。
行(省略形) |
説明 |
---|---|
|
|
|
ベーシック認証を指定し、 |
|
|
注釈
main`メソッドのコメントでは、クラスの実行を実演しています。
他のJavaクラスの例は、このクラスと似ていますが、異なるメソッドを呼び出しています。
重要
サービスの詳細は、 AccountResource を参照してください。
以下は、cURLとJavaを使って、関連する他のRESTサービスを呼び出す例です。
Accountからアカウントユーザーを取得¶
以下のcURLまたはJavaコマンドを実行すると、アカウントのユーザーを一覧表示できます。 上記と同様に、 1234
をアカウントのIDに置き換えてください。
AccountUsers GET FromAccount.sh¶
コマンド:
./AccountUsers_GET_FromAccount 1234
Code:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/user-accounts" \
-u "[email protected]:learn"
AccountUsers GET FromAccount.java¶
コマンド:
java -classpath .:* -DaccountId=1234 AccountUsers_GET_FromAccount
Code:
public static void main(String[] args) throws Exception {
UserAccountResource.Builder builder = UserAccountResource.builder();
UserAccountResource userAccountResource = builder.authentication(
"[email protected]", "learn"
).build();
Page<UserAccount> page = userAccountResource.getAccountUserAccountsPage(
Long.valueOf(System.getProperty("accountId")), null, null,
Pagination.of(1, 2), null);
System.out.println(page);
}
アカウントの UserAccountの
オブジェクトがJSONで表示されます。
アカウントロールの投稿¶
特定のアカウントに対して新しいアカウントロールを作成します。 なお、 1234
は、アカウントのIDに置き換えてください。
AccountRole POST ToAccount.sh¶
コマンド:
./AccountRole_POST_ToAccount.sh 1234
Code:
curl \
-H "Content-Type: application/json" \
-X POST \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles" \
-d "{\"name\": \"Charlie\"}" \
-u "[email protected]:learn"
AccountRole POST ToAccount.java¶
コマンド:
java -classpath .:* -DaccountId=1234 AccountRole_POST_ToAccount
Code:
public static void main(String[] args) throws Exception {
AccountRoleResource.Builder builder = AccountRoleResource.builder();
AccountRoleResource accountRoleResource = builder.authentication(
"[email protected]", "learn"
).build();
AccountRole accountRole = accountRoleResource.postAccountAccountRole(
Long.valueOf(System.getProperty("accountId")),
new AccountRole() {
{
name = "How";
}
});
System.out.println(accountRole);
}
ユーザーをアカウントロールに関連付ける¶
ユーザーを特定のアカウントロールに関連付けることができます。 1234
をアカウントのIDに置き換えてください。 お使いのアカウントのロールのIDを5678
に置き換えます。 9012
は、アカウントユーザーのIDに置き換えてください。
AccountRole POST UserAssociation.sh¶
コマンド:
./AccountRole_POST_UserAssociation.sh 1234 5678 9012
Code:
curl \
-H "Content-Type: application/json" \
-X POST \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles/${2}/user-accounts/${3}" \
-u "[email protected]:learn"
AccountRole POST UserAssociation.java¶
コマンド:
java -classpath .:* -DaccountId=1234 -DaccountRoleId=5678 -DuserAccountId=9012 AccountRole_POST_UserAssociation
Code:
AccountRoleResource.Builder builder = AccountRoleResource.builder();
AccountRoleResource accountRoleResource = builder.authentication(
"[email protected]", "learn"
).build();
accountRoleResource.postAccountAccountRoleUserAccountAssociation(
Long.valueOf(System.getProperty("accountId")),
Long.valueOf(System.getProperty("accountRoleId")),
Long.valueOf(System.getProperty("userAccountId")));
}
アカウントからのアカウントロールの取得¶
以下のcURLまたはJavaコマンドを実行することで、Accountのアカウントロールsを一覧表示することができます。 1234
をアカウントのIDに置き換えてください。
AccountRoles GET FromAccount.sh¶
コマンド:
./AccountRoles_GET_FromAccount.sh 1234
Code:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles" \
-u "[email protected]:learn"
AccountRoles GET FromAccount.java¶
コマンド:
java -classpath .:* -DaccountId=1234 AccountRoles_GET_FromAccount
Code:
public static void main(String[] args) throws Exception {
AccountRoleResource.Builder builder = AccountRoleResource.builder();
AccountRoleResource accountRoleResource = builder.authentication(
"[email protected]", "learn"
).build();
Page<AccountRole> page = accountRoleResource.getAccountAccountRolesPage(
Long.valueOf(System.getProperty("accountId")), null,
Pagination.of(1, 2), null);
System.out.println(page);
}
アカウントの AccountRoleの
オブジェクトがJSONで表示されます。
アカウントロール・ユーザー・アソシエーションの削除¶
特定のアカウントユーザーからアカウントロールの関連付けを削除します。 1234
をアカウントのIDに置き換えてください。 お使いのアカウントのロールのIDを5678
に置き換えます。 9012
は、アカウントユーザーのIDに置き換えてください。
AccountRole DELETE UserAssociation.sh¶
コマンド:
./AccountRole_DELETE_UserAssociation.sh 1234 5678 9012
Code:
curl \
-H "Content-Type: application/json" \
-X DELETE \
"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles/${2}/user-accounts/${3}" \
-u "[email protected]:learn"
AccountRole DELETE UserAssociation.java¶
コマンド
java -classpath .:* -DaccountId=1234 -DaccountRoleId=5678 -DuserAccountId=9012 AccountRole_DELETE_UserAssociation
Code:
public static void main(String[] args) throws Exception {
AccountRoleResource.Builder builder = AccountRoleResource.builder();
AccountRoleResource accountRoleResource = builder.authentication(
"[email protected]", "learn"
).build();
accountRoleResource.deleteAccountAccountRoleUserAccountAssociation(
Long.valueOf(System.getProperty("accountId")),
Long.valueOf(System.getProperty("accountRoleId")),
Long.valueOf(System.getProperty("userAccountId")));
}
APIエクスプローラーには、アカウント
のすべてのサービスとスキーマが一覧表示され、各サービスを試すためのインターフェイスがあります。