SCIMグループAPIの基礎

cURLコマンドの検証

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

curl \
"http://localhost:8080/o/scim/v1.0/v2/Groups" \
--data-raw '
	  {
		 "displayName": "Foo"
	  }' \
--header "Content-Type: application/scim+json" \
--request "POST" \
--user "test@liferay.com:learn"

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

Javaクラスを調べる

Groups_POST_ToInstance.java クラスは、 GroupResource サービスを呼び出して SCIM グループを追加します。

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

	GroupResource groupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	groupResource.postV2Group(
		new Group() {
			{
				displayName = "Foo";
			}
		});
}

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

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

Groups_GET_FromInstance.sh

コマンド：

./Groups_GET_FromInstance.sh

コード：

curl \
"http://localhost:8080/o/scim/v1.0/v2/Groups" \
--user "test@liferay.com:learn"

Groups_GET_FromInstance.java

コマンド：

java -classpath .:* Groups_GET_FromInstance

コード：

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

	GroupResource groupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(groupResource.getV2Groups(null, null));
}

Liferayインスタンスの グループ オブジェクトがJSONでリストされます。

詳細については、 API クエリ パラメータ を参照してください。

グループを取得

次の cURL または Java コマンドを使用して特定のグループを取得します。 1234 をグループのIDに置き換えます。

Groups_GET_ById.sh

コマンド:

./Groups_GET_ById.sh 1234

コード:

curl \
"http://localhost:8080/o/scim/v1.0/v2/Groups/${1}" \
--user "test@liferay.com:learn"

Groups_GET_ById.java

コマンド：

java -classpath .:* -DgroupId=1234 Groups_GET_ById

コード：

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

	GroupResource groupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		groupResource.getV2GroupById(
			String.valueOf(System.getProperty("groupId"))));
}

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

クエリパラメータの使用

クエリパラメータを使用して、取得するデータをフィルタリングできます。 以下の例では、表示名でグループを取得します。

Groups_GET_ByDisplayName.sh

コマンド：

./Groups_GET_ByDisplayName.sh 1234

コード：

curl \
	"http://localhost:8080/o/scim/v1.0/v2/Groups?filter=displayName%20eq%20%22${1}%22" \
	--user "test@liferay.com:learn"

クエリ パラメータを使用して、返されるデータを絞り込むこともできます。 たとえば、 グループ リソースをクエリする場合、上記のスクリプトのクエリを次のように変更すると、メンバーのリストが返されないようにすることができます。

http://localhost:8080/o/scim/v1.0/v2/Groups?excludedAttributes=members&filter=displayName%20eq%20%22${1}%22

グループを作成

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

Groups_PUT_ById.sh

コマンド：

./Groups_PUT_ById.sh 1234

コード：

curl \
"http://localhost:8080/o/scim/v1.0/v2/Groups/${1}" \
--data-raw '
	  {
		 "displayName": "Bar"
	  }' \
--header "Content-Type: application/scim+json" \
--request "PUT" \
--user "test@liferay.com:learn"

Groups_PUT_ById.java

コマンド：

java -classpath .:* -DgroupId=1234 Groups_PUT_ById

コード：

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

	GroupResource groupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	groupResource.putV2Group(
		String.valueOf(System.getProperty("groupId")),
		new Group() {
			{
				displayName = "Bar";
			}
		});
}

グループを削除する

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

Groups_DELETE_ById.sh

コマンド：

./Groups_DELETE_ById.sh 1234

コード：

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

Groups_DELETE_ById.java

コマンド

java -classpath .:* -DgroupId=1234 Groups_DELETE_ById

コード：

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

	GroupResource groupResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	groupResource.deleteV2Group(
		String.valueOf(System.getProperty("groupId")));
}

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

Liferay DXP 2025年第2四半期以降

次の cURL コマンドを使用して既存のグループにパッチを適用します。 1234 をグループのIDに置き換えます。

コマンド:

./Groups_PATCH_ById.sh 1234

コード:

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

関連トピック

• RESTサービスの使用