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

アカウントユーザーとロールのAPI

アプリケーションメニューからアカウントユーザーとアカウントロールを管理できますが、Liferay の REST API を使用することもできます。アカウントユーザーとロールを作成および管理するには、これらのサービスを呼び出します。

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

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

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

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

次に、以下の手順に従います。

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

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

unzip liferay-t5p9.zip

アカウント ID のリストを取得するには、 Accounts_GET_FromInstance リソースを使用します。ユーザーを追加したいアカウントIDをメモしてください。

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

./UserAccounts_POST_ToAccount.sh 1234

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

{
  "accountBriefs": [
    {
      "id": 38935,
      "name": "Able",
      "roleBriefs": []
    }
  ],
  "additionalName": "",
  "alternateName": "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": "",
  "familyName": "Easy",
  "givenName": "Dog",
  "id": 39005,
  "jobTitle": "",
  "keywords": [],
  "name": "Dog Easy",
  "organizationBriefs": [],
  "profileURL": "",
  "roleBriefs": [
    {
      "id": 20111,
      "name": "User"
    }
  ],
  "siteBriefs": [
    {
      "id": 20125,
      "name": "Global"
    },
    {
      "id": 20123,
      "name": "Guest"
    }
  ],
  "userAccountContactInformation": {
    "emailAddresses": [],
    "facebook": "",
    "jabber": "",
    "postalAddresses": [],
    "skype": "",
    "sms": "",
    "telephones": [],
    "twitter": "",
    "webUrls": []
  }
}

グローバルメニュー → アプリケーション → アカウントに移動します。ユーザーを作成したアカウントをクリックします。 ユーザー タブをクリックして、作成された新しいユーザーを確認します。

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

RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。以下のコマンドでソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
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",
			"emailAddress": "dog@liferay.com",
			"familyName": "Easy",
			"givenName": "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\": \"Easy\", \"givenName\": \"Dog\"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注

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

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

Javaクラスを調べる

Account_POST_ToInstance.java クラスは、関連するサービスを呼び出して、アカウントユーザーを追加します。

このクラスは、わずか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依存関係情報は、/o/apiでインストール先のAPIエクスプローラーで確認できます。

注

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

他の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 "DELETE" \
	--user "test@liferay.com:learn"

AccountRole_DELETE_UserAssociation.java

コマンド

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

コード:

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

注

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

Capability:

Development and Tooling

Resource Type:

Official Documentation

Feature:

Data Frameworks

Deployment Approach:

Liferay PaaS

Liferay Self-Hosted