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

SCIMユーザーAPIの基本

Liferay DXP 2024.Q1+/Portal GA112+

Liferayは、SCIMユーザーに対するCRUD操作を実行するためのヘッドレスAPIを提供し、ユーザーのID情報を企業のアプリケーションと同期させます。 SCIMユーザーを管理するには、APIエクスプローラーから/scimエンドポイントを使用します。

SCIM 属性のカスタムフィールドへのマッピング

Liferay DXP 2025.Q4+

Liferayは、SCIMプロビジョニング中に追加のSCIM属性を処理します。 受信したSCIMペイロードに、組み込みのユーザーフィールドにマッピングされない属性が含まれている場合、Liferayは対応するカスタムフィールドを自動的に作成し、そこに値を保存します。

入力された住所、複数のメールアドレス、電話番号、プロフィールURL、インスタントメッセージのハンドル名、その他の拡張機能属性は、可能な場合は組み込みフィールドに直接マッピングされます。 残りの属性はすべて、Userエンティティの下に自動作成されたカスタムフィールドにマッピングされます。

ユーザーの追加

新しい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に変更します。

Liferayが起動したら、

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

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

    unzip liferay-g7y9.zip

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

    ./Users_POST_ToInstance.sh

    JSONレスポンスには、新しいSCIMユーザーの追加が示されています。

    {
   "emails": [
      {
         "type": "default",
         "value": "able@liferay.com",
         "primary": true
      }
   ],
   "meta": {
      "created": "2024-03-13T09:53:22Z",
      "location": "http://localhost:8080/o/scim/v1.0/v2/Users/36433",
      "lastModified": "2024-03-13T09:53:23Z",
      "resourceType": "User"
   },
   "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:User",
      "urn:ietf:params:scim:schemas:extension:liferay:2.0:User"
   ],
   "urn:ietf:params:scim:schemas:extension:liferay:2.0:User": {
      "birthday": "1970-01-01",
      "male": true
   },
   "name": {
      "familyName": "Baker",
      "givenName": "Able"
   },
   "active": true,
   "externalId": "1446cf10-3de9-6e11-dd15-c561de806259",
   "id": "36433",
   "title": "",
   "userName": "able.baker"
}

  3. グローバルメニュー (Applications Menu icon) を開き、 コントロールパネル → ユーザーと組織 に移動して、これを確認してください。 新しいユーザーが追加されたことを確認してください。

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

  4. または、Javaクライアントを使用してRESTサービスを呼び出します。 java 

    javac -classpath .:* *.java

  5. Users_POST_ToInstance クラスを実行します。

    java -classpath .:* Users_POST_ToInstance

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"

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

引数説明
"http://localhost:8080/o/scim/v1.0/v2/Users"RESTサービスのエンドポイント
--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"リクエスト本文の形式がJSONであり、SCIMプロトコルに準拠していることを示します。
--request "POST"指定されたエンドポイントで起動するHTTPメソッド
--user "test@liferay.com:learn"基本的な認証情報
注

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

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

行（省略形）説明
UserResource.Builder builder = ...Builder を取得して、 UserResource サービス インスタンスを生成します。
UserResource userResource = builder.authentication(...).build();基本認証を使用して、 UserResource サービス インスタンスを生成します。
userResource.postV2User(...);userResource.postV2User メソッドを呼び出します。

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

注

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

重要

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

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インスタンスの ユーザー オブジェクトはJSON形式で表示されます。

詳細については、 APIクエリパラメータ をお読みください。

ユーザーの取得

以下のcURLまたはJavaコマンドを使用して、特定のユーザーを取得します。 1234 をユーザーIDに置き換えてください。

ヒント

Users_GET_FromInstance.[java|sh] を使用してすべてのユーザーのリストを取得し、特定のユーザーの 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"))));
}

User フィールドは 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"

クエリパラメータを使用することで、返されるデータを絞り込むこともできます。 Users リソースをクエリする場合、フィルタリングは externalId および userName 属性のみをサポートします。 例えば、上記のスクリプトのクエリを次のように変更することで、結果を絞り込むことができます。

http://localhost:8080/o/scim/v1.0/v2/Users?filter=userName%20eq%20%22${1}%22

ユーザーの配置

以下の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.Q2+

以下の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エクスプローラー は、すべての ユーザー サービスとスキーマを一覧表示し、各サービスを試すためのインターフェースを備えています。

バージョンごとの機能提供状況

機能Liferay DXPバージョンポータルバージョンメモ
SCIM 属性のカスタムフィールドへのマッピング2025年第4四半期以降-当初はリリース機能としてリリースされました（LPD-56434）。 Liferay DXP 2026.Q1で一般提供（GA）されました。
Capability:
Platform
Resource Type:
Official Documentation
Feature:
API Development
DXP Configuration
Identity Management and Authentication
Deployment Approach:
Liferay PaaS
Liferay SaaS
Liferay Self-Hosted