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

ユーザーアカウントAPIの基本

コントロールパネルからユーザーの追加と管理ができますが、LiferayのREST APIを利用することもできます。これらのサービスを呼び出すことで、ユーザーの追加、編集、削除を行うことができます。

まずは新しいユーザーを追加することから始めましょう。

ユーザーの追加

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

docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.132-ga132

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

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

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

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

unzip liferay-y6q4.zip

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

./UserAccounts_POST_ToInstance.sh

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

{
  "additionalName": "",
  "alternateName": "able",
  "birthDate": "1977-01-01T00:00:00Z",
  "customFields": [],
  "dashboardURL": "",
  "dateCreated": "2021-05-19T16:04:46Z",
  "dateModified": "2021-05-19T16:04:46Z",
  "emailAddress": "able@liferay.com",
  "familyName": "Foo",
  "givenName": "Able",
  "id": 39321,
  "jobTitle": "",
  "keywords": [],
  "name": "Able Foo",
  "organizationBriefs": [],
  "profileURL": "",
  "roleBriefs": [
    {
      "id": 20113,
      "name": "User"
    }
  ],
  "siteBriefs": [
    {
      "id": 20127,
      "name": "Global"
    },
    {
      "id": 20125,
      "name": "Guest"
    }
  ],
  "userAccountContactInformation": {
    "emailAddresses": [],
    "facebook": "",
    "jabber": "",
    "postalAddresses": [],
    "skype": "",
    "sms": "",
    "telephones": [],
    "twitter": "",
    "webUrls": []
  }
}%

グローバルメニュー () を開き、 コントロールパネル → ユーザーと組織 に移動します。新規ユーザーの追加を確認します。後続のコマンドのために、ユーザーの ID 番号をメモしてください。

新規ユーザーの追加を確認します。

RESTサービスは、Javaクラスで呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。以下のコマンドでソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
以下のコマンドを使用して、 UserAccounts_POST_ToInstance クラスを実行します。
```
java -classpath .:* UserAccounts_POST_ToInstance
```
グローバルメニュー () を開き、 コントロールパネル → ユーザーと組織 に移動します。新規ユーザーの追加を確認します。

cURLコマンドとJavaクラスの仕組みをご覧ください。

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts" \
	--data-raw '
		{
			"alternateName": "Able",
			"emailAddress": "able@liferay.com",
			"familyName": "Foo",
			"givenName": "Able"
		}' \
	--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/user-accounts"`	RESTサービスのエンドポイント
`-d "{\"alternateName\": \"Able\", \"emailAddress\": \"able@liferay.com\", \"familyName\": \"Foo\", \"givenName\": \"Able\"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注

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

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

Javaクラスを調べる

UserAccounts_POST_ToInstance.java クラスは、 UserAccountResource サービスを呼び出すことでユーザーを追加します。

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

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

	UserAccount userAccount = userAccountResource.postUserAccount(
		new UserAccount() {
			{
				alternateName = "Baker";
				emailAddress = "baker@liferay.com";
				familyName = "Foo";
				givenName = "Baker";
			}
		});

	System.out.println(userAccount);
}

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

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

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

注

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

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

重要

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

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

フィルタークエリ	説明
`status eq 0`	ユーザーアカウントの状態は `アクティブ` である必要があります。
`status eq 5`	ユーザーアカウントの状態は `非アクティブ` である必要があります。
`roleIds in ('20100', 20104')`	ユーザーアカウントには、管理者（`20100`）またはパワーユーザー（`20104`）の役割が必要です。
`jobTitle eq 'Parts Consultant'`	ユーザーアカウントの役職名は「部品コンサルタント」でなければなりません。
`customFields/githubProfileUrl eq 'www.github.com/able.foo'`	ユーザーアカウントには、 `githubProfileUrl` というカスタムフィールドがあり、その値は `www.github.com/able.foo` です。

ソートクエリ	説明
`dateCreated:desc`	`dateCreated` で降順に並べ替えます。
`dateCreated:desc,lastLoginDate:desc`	まず、 `dateCreated` で降順に並べ替え、次に `lastLoginDate` で降順に並べ替えます。

ユーザーの配置

以下のcURLコマンドとJavaコマンドを使用して、既存ユーザーのデータを完全に上書きします。注： 1234 をユーザーIDに置き換えてください。

UserAccounts_PUT_ById.sh

コマンド：

./UserAccounts_PUT_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/${1}" \
	--data-raw '
		{
			"alternateName": "Able",
			"emailAddress": "able@liferay.com",
			"familyName": "Goo",
			"givenName": "Able"
		}' \
	--header "Content-Type: application/json" \
	--request "PUT" \
	--user "test@liferay.com:learn"

UserAccounts_PUT_ById.java

コマンド：

java -classpath .:* -DuserId=1234 UserAccounts_PUT_ById

コード：

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

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

	UserAccount userAccount = userAccountResource.putUserAccount(
		Long.valueOf(System.getProperty("userId")),
		new UserAccount() {
			{
				alternateName = "Baker";
				emailAddress = "baker@liferay.com";
				familyName = "Goo";
				givenName = "Baker";
			}
		});

	System.out.println(userAccount);
}

これにより、例中の以前のデータがAble GooとBaker Gooに置き換えられます。

これまでのユーザーデータは、パッチサービスに置き換えられています。

ヒント

UserAccounts_PATCH_ById.[java|sh] または UserAccounts_PUT_ById.[java|sh] を使用して、 status フィールドを Active または Inactive に変更してユーザーをアクティブ化または非アクティブ化します。ワークフローがアクティブなユーザーのステータスを変更するには、代わりに headless-admin-workflow API を使用する必要があります。使用方法の詳細は、 API Explorer を参照してください。

ユーザーの削除

以下のcURLコマンドとJavaコマンドを使用して、既存のユーザーを削除します。注： 1234 をユーザーIDに置き換えてください。

UserAccounts_DELETE_ById.sh

コマンド：

./UserAccounts_DELETE_ById.sh 1234

コード：

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

UserAccounts_DELETE_ById.java

コマンド:

java -classpath .:* -DuserId=1234 UserAccounts_DELETE_ById

コード:

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

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

	userAccountResource.deleteUserAccount(
		Long.valueOf(System.getProperty("userId")));
}

これにより、ユーザーAble GooとBaker Gooの両方が削除されます。

API Explorer をチェックして、ユーザー関連の REST サービスの一覧を確認してください。

注

PostalAddresses_GET_FromUser を使用してユーザーの郵便番号を取得します。

Capability:

Development and Tooling

Resource Type:

Official Documentation

Feature:

Data Frameworks

Deployment Approach:

Liferay PaaS

Liferay Self-Hosted

ユーザーアカウントAPIの基本

ユーザーの追加

cURLコマンドの検証

Javaクラスを調べる

インスタンスユーザーの取得

UserAccounts_GET_FromInstance.sh

UserAccounts_GET_FromInstance.java

ユーザーのフィルタリング、ページネーション、検索、および並べ替え

ユーザーの取得

UserAccounts_GET_ById.sh

UserAccounts_GET_ById.java

ユーザーへのパッチ

UserAccounts_PATCH_ById.sh

UserAccounts_PATCH_ById.java

ユーザーの配置

UserAccounts_PUT_ById.sh

UserAccounts_PUT_ById.java

ユーザーの削除

UserAccounts_DELETE_ById.sh

UserAccounts_DELETE_ById.java