SCIM ユーザー API の基礎

cURLコマンドの検証

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

curl \
"http://localhost:8080/o/scim/v1.0/v2/Users" \
--data-raw '
	  {
		 "active": "'true'",
		 "emails": [
			{
			   "primary": "'true'",
			   "type": "default",
			   "value": "able@liferay.com"
			}
		 ],
		 "name": {
			"familyName": "Baker",
			"givenName": "Able"
		 },
		 "userName": "able.baker"
	  }' \
--header "Content-Type: application/scim+json" \
--request "POST" \
--user "test@liferay.com:learn"

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

Javaクラスを調べる

Users_POST_ToInstance.java クラスは、 UserResource サービスを呼び出して SCIM ユーザーを追加します。

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

	UserResource userResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	userResource.postV2User(
		new User() {
			{
				active = true;
				name = new Name() {
					{
						familyName = "Baker";
						givenName = "Able";
					}
				};
				emails = new MultiValuedAttribute[] {
					new MultiValuedAttribute() {
						{
							primary = true;
							type = "default";
							value = "able@liferay.com";
						}
					}
				};
				userName = "able.baker";
			}
		});
}

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

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

Users_GET_FromInstance.sh

コマンド：

./Users_GET_FromInstance.sh

コード：

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

Users_GET_FromInstance.java

コマンド：

java -classpath .:* Users_GET_FromInstance

コード：

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

	UserResource userResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(userResource.getV2Users(null, null));
}

Liferayインスタンスの User オブジェクトがJSON形式でリストされています。

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

ユーザーの取得

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

Users_GET_ById.sh

コマンド：

./Users_GET_ById.sh 1234

コード：

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

Users_GET_ById.java

コマンド：

java -classpath .:* -DuserId=1234 Users_GET_ById

コード：

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

	UserResource userResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		userResource.getV2UserById(
			String.valueOf(System.getProperty("userId"))));
}

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

Users_GET_ByUserName.sh

フィルターを使用してユーザーを取得できます。 この例では、ユーザー名でユーザーを取得します。

コマンド：

./Users_GET_ByUserName.sh 1234

コード：

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

ユーザーの配置

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

Users_PUT_ById.sh

コマンド：

./Users_PUT_ById.sh 1234

コード：

curl \
"http://localhost:8080/o/scim/v1.0/v2/Users/${1}" \
--data-raw '
	  {
		 "emails": [
			{
			   "primary": true,
			   "type": "default",
			   "value": "able@liferay.com"
			}
		 ],
		 "name": {
			"familyName": "Charlie",
			"givenName": "Able"
		 },
		 "userName": "able.baker"
	  }' \
--header "Content-Type: application/scim+json" \
--request "PUT" \
--user "test@liferay.com:learn"

Users_PUT_ById.java

コマンド：

java -classpath .:* -DuserId=1234 Users_PUT_ById

コード：

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

	UserResource userResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	userResource.putV2User(
		String.valueOf(System.getProperty("userId")),
		new User() {
			{
				name = new Name() {
					{
						familyName = "Charlie";
						givenName = "Able";
					}
				};
				emails = new MultiValuedAttribute[] {
					new MultiValuedAttribute() {
						{
							primary = true;
							type = "default";
							value = "able@liferay.com";
						}
					}
				};
				userName = "able.baker";
			}
		});
}

ユーザーを非アクティブ化する

次の cURL および Java コマンドを使用して、既存のユーザーを非アクティブ化します。 1234 をユーザーIDに置き換えます。

Users_DELETE_ById.sh

コマンド:

./Users_DELETE_ById.sh 1234

コード：

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

Users_DELETE_ById.java

コマンド

java -classpath .:* -DuserId=1234 Users_DELETE_ById

コード:

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

	UserResource userResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	userResource.deleteV2User(String.valueOf(System.getProperty("userId")));
}

ユーザーへのパッチ

Liferay DXP 2025年第2四半期以降

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

コマンド：

./Users_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/scim/v1.0/v2/Users/${1}" \
	--data-raw '
		{
			"Operations": [
				{
					"op": "replace",
					"path": "name.givenName",
					"value": "Abel"
				}
				],
				"schemas": [
					"urn:ietf:params:scim:api:messages:2.0:PatchOp"
				]
		}' \
	--header "Content-Type: application/scim+json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

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

関連トピック

• RESTサービスの使用