ユーザーグループ API の基本

アプリケーション メニューから ユーザー グループの作成と管理 を行うことができますが、Liferay の REST API を使用することもできます。 ユーザー グループを管理するには、これらのサービスを呼び出します。

ユーザーグループの追加

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

メールアドレス test@liferay.com とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。

次に、次の手順に従います。

1. ユーザー グループ API の基礎をダウンロードして解凍します。

   curl https://resources.learn.liferay.com/examples/liferay-y6f2.zip -O
   

   unzip liferay-y6f2.zip
   

2. cURL スクリプトを使用して、インスタンスに新しいユーザー グループを追加します。 コマンドラインで、curlフォルダに移動します。 UserGroups_POST_ToInstance.sh スクリプトを実行します。

   ./UserGroups_POST_ToInstance.sh
   

   JSON 応答には、新しいユーザー グループが追加されたことが示されています。

   {
     "description" : "",
     "externalReferenceCode" : "72c5739f-a6e9-d4b8-5481-7cf1a427ea79",
     "id" : 43099,
     "name" : "Able",
     "usersCount" : 0
   }
   

3. グローバル メニュー → コントロール パネル → ユーザー グループに移動します。 新しいユーザー グループが追加されたことを確認します。

   

4. RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。 以下のコマンドでソースファイルをコンパイルします。

   javac -classpath .:* *.java
   

5. 次のコマンドで UserGroups_POST_ToInstance.java クラスを実行します。

   java -classpath .:* UserGroups_POST_ToInstance
   

cURLコマンドの検証

UserGroups_POST_ToInstance.sh スクリプトは、cURL コマンドを使用して REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups" \
	--data-raw '
		{
			"name": "Able"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

ここでは、コマンドの引数を紹介します。

他のcURLコマンドも同様のJSON引数を使用しています。

Javaクラスを調べる

UserGroups_POST_ToInstance.java クラスは、ユーザー グループ関連のサービスを呼び出してユーザー グループを追加します。

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	UserGroup userGroup = userGroupResource.postUserGroup(
		new UserGroup() {
			{
				name = "Dog";
			}
		});

	System.out.println(userGroup);
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

プロジェクトには、依存関係としてcom.liferay.headless.admin.user.client.jarファイルが含まれていることに注意してください。 すべてのRESTアプリケーションのクライアントJAR依存関係情報は、/o/apiでインストール先のAPIエクスプローラーで確認できます。

他の Java クラスの例もこれに似ていますが、異なる UserGroupResource メソッドを呼び出します。

以下は、cURL と Java を使用して他の UserGroup REST サービスを呼び出す例です。

インスタンスからユーザーグループを取得する

次の cURL または Java コマンドを実行すると、ユーザー グループを一覧表示できます。

ユーザーグループ_GET_FromInstance.sh

コマンド：

./UserGroups_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups" \
	--user "test@liferay.com:learn"

UserGroups_GET_FromInstance.java

コマンド：

java -classpath .:* UserGroups_GET_FromInstance

コード：

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		userGroupResource.getUserGroupsPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスの UserGroup オブジェクトが JSON に表示されます。

ユーザーグループを取得する

次の cURL または Java コマンドを使用して、特定のユーザー グループを取得します。

ユーザーグループ_GET_ById.sh

コマンド：

./UserGroups_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups/${1}" \
	--user "test@liferay.com:learn"

UserGroups_GET_ById.java

コマンド：

java -classpath .:* -DuserGroupId=1234 UserGroups_GET_ById

コード：

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		userGroupResource.getUserGroup(
			Long.valueOf(System.getProperty("userGroupId"))));
}

UserGroup フィールドが JSON に表示されます。

ユーザーグループにパッチを適用する

次の cURL および Java コマンドを使用して、既存のユーザー グループを部分的に編集します。 1234 をユーザー グループの ID に置き換えます。

ユーザーグループ_PATCH_ById.sh

コマンド：

./UserGroups_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups/${1}" \
	--data-raw '
		{
			"name": "Baker"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

ユーザーグループ_PATCH_ById.java

コマンド：

java -classpath .:* -DuserGroupId=1234 UserGroups_PATCH_ById

コード：

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	UserGroup userGroup = userGroupResource.patchUserGroup(
		Long.valueOf(System.getProperty("userGroupId")),
		new UserGroup() {
			{
				name = "Easy";
			}
		});

	System.out.println(userGroup);
}

ユーザーグループを作成する

次の cURL および Java コマンドを使用して、既存のユーザー グループを完全に上書きします。 1234 をユーザー グループの ID に置き換えます。

ユーザーグループ_PUT_ById.sh

コマンド：

./UserGroups_PUT_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups/${1}" \
	--data-raw '
		{
			"name": "Charlie"
		}' \
	--header "Content-Type: application/json" \
	--request "PUT" \
	--user "test@liferay.com:learn"

UserGroups_PUT_ById.java

コマンド：

java -classpath .:* -DuserGroupId=1234 UserGroups_PUT_ById

コード：

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	UserGroup userGroup = userGroupResource.putUserGroup(
		Long.valueOf(System.getProperty("userGroupId")),
		new UserGroup() {
			{
				name = "Fox";
			}
		});

	System.out.println(userGroup);
}

ユーザーグループを削除する

次の cURL および Java コマンドを使用して、既存のユーザー グループを削除します。 1234 をユーザー グループの ID に置き換えます。

ユーザーグループ_DELETE_ById.sh

コマンド：

./UserGroups_DELETE_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-groups/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

ユーザーグループ_DELETE_ById.java

コマンド

java -classpath .:* -DuserGroupId=1234 UserGroups_DELETE_ById

コード：

public static void main(String[] args) throws Exception {
	UserGroupResource.Builder builder = UserGroupResource.builder();

	UserGroupResource userGroupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	userGroupResource.deleteUserGroup(
		Long.valueOf(System.getProperty("userGroupId")));
}

API エクスプローラー には、すべての ユーザーグループ サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。