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

アカウントユーザーと役割に関するAPI

[アプリケーション] メニューから アカウント ユーザー と アカウント ロール を管理できますが、Liferay の REST API を使用することもできます。 アカウントユーザーと役割を作成および管理するには、これらのサービスにご連絡ください。

アカウントユーザーの追加

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

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

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

次に、以下の手順に従ってください。

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

    curl https://resources.learn.liferay.com/examples/liferay-t5p9.zip -O
    
    unzip liferay-t5p9.zip
    
  2. アカウント ID のリストを取得するには、 Accounts_GET_FromInstance リソースを使用します。 ユーザーを追加したいアカウントIDをメモしておいてください。

  3. cURLスクリプトを使用して、アカウントに新しいユーザーを追加します。 コマンドラインで、 curl フォルダーに移動します。 アカウント ID をパラメータとして UserAccounts_POST_ToAccount.sh スクリプトを実行します。

    ./UserAccounts_POST_ToAccount.sh 1234
    

    JSONレスポンスには、新しいアカウントが追加されたことが示されています。

    {
      "accountBriefs": [
        {
          "id": 38935,
          "name": "Able",
          "役割ブリーフ": []
        }
      ],
      "追加名": "",
      "代替名": "dog",
      "birthDate": "1977-01-01T00:00:00Z",
      "customFields": [],
      "dashboardURL": ""、
      "dateCreated": "2021-10-12T21:00:59Z"、
      "dateModified": "2021-10-12T21:01:01Z",
      "emailAddress": "dog@liferay.com",
      "externalReferenceCode": ""、
      "家族名": "簡単",
      "与えられた名前": "犬"、
      "id": 39005、
      "jobTitle": ""、
      "keywords": []、
      "名前": "Dog Easy"、
      "organizationBriefs": []、
      "profileURL": ""、
      "roleBriefs": [
        {
          "id": 20111、
          "name": "ユーザー"
        }
      ],
      "siteBriefs": [
        {
          "id": 20125,
          "名前": "グローバル"
        },
        {
          "ID": 20123,
          "名前": "ゲスト"
        }
      ],
      "ユーザーアカウント連絡先情報": {
        "メールアドレス": [],
        "facebook": ""、
        "jabber": ""、
        "postalAddresses": [],
        "Skype": "",
        "SMS": "",
        "電話": [],
        "Twitter": "",
        "Web URL": []
      }
    }
    
  4. グローバルメニュー → コントロールパネル → アカウント に移動します。 ユーザーを作成したアカウントをクリックしてください。 ユーザー タブをクリックすると、新しく作成されたユーザーが表示されます。

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

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

    javac -classpath .:* *.java
    
  2. 以下のコマンドで AccountUser_POST_ToAccount.java クラスを実行します。 1234 をアカウントの ID に置き換えてください。

    java -classpath .:* -DaccountId=1234 AccountUser_POST_ToAccount
    

cURLコマンドを調べてみましょう

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

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/user-accounts" \
	--data-raw '
		{
			"alternateName": "Dog",
			"メールアドレス": "dog@liferay.com"、
			"姓": "Easy"、
			"名": "Dog"
		}' \
	--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/accounts/${1}/user-accounts"RESTサービスのエンドポイント
-d "{\"alternateName\": \"Dog\", \"emailAddress\": \"dog@liferay.com\", \"familyName\": \"簡単\"、\"名\": \"犬\"}"お客様が掲載を希望するデータ
-u "test@liferay.com:learn"基本的な認証情報
注記

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

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

Javaクラスを調べます

Account_POST_ToInstance.java クラスは、 UserAccountResource サービスを呼び出すことにより、アカウント ユーザーを追加します。

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

行(省略形)説明
UserAccountResource.Builder builder = ... UserAccountResource サービスインスタンスを生成するためのBuilderを取得します。
UserAccountResource userAccountResource = builder.authentication(...).build();ベーシック認証を指定し、 UserAccountResource サービスインスタンスを生成します。
UserAccount userAccount = userAccountResource.postAccountUserAccount(...);userAccountResource.postAccountUserAccount メソッドを呼び出し、データをpostに渡します。

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

注記

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

他のJavaクラスの例はこれと似ていますが、呼び出すメソッドが異なります。

重要

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

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

アカウントからアカウントユーザーを取得する

以下のcURLコマンドまたはJavaコマンドを実行することで、アカウントのユーザー一覧を表示できます。 上記と同様に、 1234 をあなたのアカウントのIDに置き換えてください。

UserAccounts_GET_FromAccount.sh

コマンド:

./UserAccounts_GET_FromAccount 1234

コード:

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

AccountUsers_GET_FromAccount.java

コマンド:

java -classpath .:* -DaccountId=1234 AccountUsers_GET_FromAccount

コード:

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

	UserAccountResource userAccountResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<UserAccount> page = userAccountResource.getAccountUserAccountsPage(
		Long.valueOf(System.getProperty("accountId")), null, null,
		Pagination.of(1, 2), null);

	System.out.println(page);
}

アカウントの UserAccount オブジェクトは JSON で表示されます。

アカウントロールを投稿する

特定のアカウントに対して新しいアカウントロールを作成します。 注: 1234 をアカウントのIDに置き換えてください。

AccountRoles_POST_ToAccount.sh

コマンド:

./AccountRoles_POST_ToAccount.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles" \
	--data-raw '
		{
			"name": "Charlie"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

AccountRole_POST_ToAccount.java

コマンド:

java -classpath .:* -DaccountId=1234 AccountRole_POST_ToAccount

コード:

ユーザーをアカウントロールに関連付ける

ユーザーを特定のアカウントロールに関連付けることができます。 1234 をあなたのアカウント ID に置き換えてください。 5678 をアカウントロールの ID に置き換えてください。 9012 をあなたのアカウントのユーザーIDに置き換えてください。

AccountRoles_POST_UserAssociation.sh

コマンド:

./AccountRoles_POST_UserAssociation.sh 1234 5678 9012

コード:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles/${2}/user-accounts/${3}" \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

AccountRole_POST_UserAssociation.java

コマンド:

java -classpath .:* -DaccountId=1234 -DaccountRoleId=5678 -DuserAccountId=9012 AccountRole_POST_UserAssociation

コード:

アカウントからアカウントロールを取得する

以下のcURLコマンドまたはJavaコマンドを実行することで、アカウントのアカウントロールを一覧表示できます。 1234 をあなたのアカウント ID に置き換えてください。

AccountRoles_GET_FromAccount.sh

コマンド:

./AccountRoles_GET_FromAccount.sh 1234

コード:

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

AccountRoles_GET_FromAccount.java

コマンド:

java -classpath .:* -DaccountId=1234 AccountRoles_GET_FromAccount

コード:

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

	AccountRoleResource accountRoleResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<AccountRole> page = accountRoleResource.getAccountAccountRolesPage(
		Long.valueOf(System.getProperty("accountId")), null,
		Pagination.of(1, 2), null);

	System.out.println(page);
}

アカウントの AccountRole オブジェクトは JSON で表示されます。

アカウントロールのユーザー関連付けを削除します

特定のアカウントユーザーからアカウントロールの関連付けを削除します。 1234 をあなたのアカウント ID に置き換えてください。 5678 をアカウントロールの ID に置き換えてください。 9012 をあなたのアカウントのユーザーIDに置き換えてください。

AccountRoles_DELETE_UserAssociation.sh

コマンド:

./AccountRoles_DELETE_UserAssociation.sh 1234 5678 9012

コード:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/accounts/${1}/account-roles/${2}/user-accounts/${3}" \
	--header "Content-Type: application/json" \
	--request "削除" \
	--user "test@liferay.com:learn"

AccountRole_DELETE_UserAssociation.java

指示

java -classpath .:* -DaccountId=1234 -DaccountRoleId=5678 -DuserAccountId=9012 AccountRole_DELETE_UserAssociation

コード:

API Explorer には、すべての アカウント サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

注記

Liferay DXP 2024.Q4+/Portal GA129+ では、外部参照コードを使用して GET/PUT/PATCH/DELETE アカウント ロールを実行できます。