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

アプリケーションメニューから Create and Manage User Groups ができますが、Liferay の REST API を使うこともできます。 これらのサービスを呼び出して、ユーザーグループを管理する。

ユーザーグループの追加

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q1.1。

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

その後、以下の手順に従ってください:

  1. User Groups API Basics をダウンロードして解凍します。

    curl https://resources.learn.liferay.com/dxp/latest/en/users-and-permissions/developer-guide/liferay-y6f2.zip -O
    
    unzip liferay-y6f2.zip
    
  2. cURLスクリプトを使用して、インスタンスに新しいユーザーグループを追加します。 コマンドラインで、 curlフォルダに移動します。 UserGroup_POST_ToInstance.sh スクリプトを実行します。

    ./UserGroup_POST_ToInstance.sh
    

    JSONレスポンスは、新しいユーザーグループが追加されたことを示している:

    {
      "description" : "",
      "externalReferenceCode" : "72c5739f-a6e9-d4b8-5481-7cf1a427ea79",
      "id" : 43099,
      "name" : "Able",
      "usersCount" : 0
    }
    
  3. Global MenuControl PanelUser Groups に移動する。 新しいユーザーグループが追加されていることを確認してください。

    新しいユーザーグループが追加されていることを確認してください。

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

    javac -classpath .:* *.java
    
  5. UserGroup_POST_ToInstance.java クラスを以下のコマンドで実行する。

    java -classpath .:* UserGroup_POST_ToInstance
    

cURLコマンドの検証

UserGroup_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"基本的な認証情報
note

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

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

Javaクラスを調べる

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

行(省略形)説明
UserGroupResource.Builder builder = ...UserGroupResource サービスインスタンスを生成するための Builder を取得します。
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エクスプローラーで確認できます。

note

mainメソッドのコメントでは、クラスの実行を実演しています。

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

important

サービスの詳細は 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

コード:


	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コマンドで特定のユーザー・グループを取得する。

tip

インスタンスの ユーザグループ ID を取得するには UserGroups_GET_FromInstance.[java|sh] を使用してください。

UserGroup_GET_ById.sh

コマンド:

./UserGroup_GET_ById.sh 1234

コード:

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

UserGroup_GET_ById.java

コマンド:

java -classpath .:* -DuserGroupId=1234 UserGroup_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に置き換えてください。

UserGroup_PATCH_ById.sh

コマンド:

./UserGroup_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"

UserGroup_PATCH_ById.java

コマンド:

java -classpath .:* -DuserGroupId=1234 UserGroup_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に置き換えてください。

UserGroup_PUT_ById.sh

コマンド:

./UserGroup_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"

UserGroup_PUT_ById.java

コマンド:

java -classpath .:* -DuserGroupId=1234 UserGroup_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に置き換えてください。

UserGroup_DELETE_ById.sh

コマンド:

./UserGroup_DELETE_ById.sh 1234

コード:

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

UserGroup_DELETE_ById.java

コマンド

java -classpath .:* -DuserGroupId=1234 UserGroup_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 のすべてのサービスとスキーマが表示され、各サービスを試すためのインターフェイスが用意されている。

Capabilities

Product

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy