ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

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

ユーザーグループの作成と管理はアプリケーションメニューから行えますが、LiferayのREST APIを使うこともできます。ユーザーグループを管理するには、これらのサービスにご連絡ください。

ユーザーグループの追加

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

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

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

それでは、以下の手順に従ってください。

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

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

unzip liferay-y6f2.zip

cURLスクリプトを使用して、インスタンスに新しいユーザーグループを追加します。コマンドラインで、curlフォルダに移動します。 UserGroups_POST_ToInstance.sh スクリプトを実行します。
```
./UserGroups_POST_ToInstance.sh
```
JSONレスポンスには、新しいユーザーグループが追加されたことが示されています。
```
{
  "description" : "",
  "externalReferenceCode" : "72c5739f-a6e9-d4b8-5481-7cf1a427ea79",
  "id" : 43099,
  "name" : "Able",
  "usersCount" : 0
}
```
グローバルメニュー → コントロールパネル → ユーザーグループ に移動します。新しいユーザーグループが追加されたことを確認してください。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。以下のコマンドでソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
以下のコマンドで 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"

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

引数	説明
`-H "Content-Type: application/json"`	リクエストボディのフォーマットがJSONであることを示します。
`-X POST`	指定されたエンドポイントで起動するHTTPメソッド
`"http://localhost:8080/o/headless-admin-user/v1.0/user-groups"`	RESTサービスのエンドポイント
`-d "{\"name\": \"Able\"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注

ここでは、デモのために基本的な認証を使用しています。本番環境では、 OAuth2 を介してユーザーを認証する必要があります。 OAuth2 を使用する React アプリケーションの例については、 OAuth2 を使用してユーザーを認証するを参照してください。

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

Javaクラスを調べる

UserGroups_POST_ToInstance.java クラスは、 UserGroupResource サービスを呼び出すことでユーザーグループを追加します。

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サービスを呼び出します。

行（省略形）	説明
`UserGroupResource.Builder builder = ...`	`Builder` を取得して、 `UserGroupResource` サービスインスタンスを生成します。
`UserGroupResource userGroupResource = builder.authentication(...).build();`	基本認証を指定し、 `UserGroupResource` サービスインスタンスを生成します。
`UserGroup userGroup = userGroupResource.postUserGroup(...);`	`userGroupResource.postUserGroup` メソッドを呼び出し、データを post に渡します。

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

注

main メソッドのコメントは、クラスを実行する方法を示しています。

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

重要

サービスの詳細については、 UserGroupResource を参照してください。

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

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

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

UserGroups_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コマンドを使用して、特定のユーザーグループを取得します。

ヒント

UserGroups_GET_FromInstance.[java|sh] を使用して、インスタンス ユーザーグループ ID を取得します。

UserGroups_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 に置き換えてください。

UserGroups_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"

UserGroups_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 に置き換えてください。

UserGroups_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 に置き換えてください。

UserGroups_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"

UserGroups_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 Explorer には、 UserGroup のすべてのサービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

Capability: