ユーザーアカウントAPIの基本
コントロールパネルから ユーザーの追加と管理 ができますが、Liferay の REST API を使うこともできます。 これらのサービスを呼び出して、ユーザーの追加、編集、削除を行うことができます。
まず、新しいユーザーを追加します。
ユーザーの追加
新しいLiferay インスタンスを起動し、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/portal:7.4.3.120-ga120。
http://localhost:8080でLiferayへのサインインします。 メールアドレス test@liferay.com とパスワード test を使用してください。 プロンプトが表示されたら、パスワードを learn に変更します。
次に、以下の手順に従います。
-
User Account API Basics をダウンロードして解凍する。
curl https://resources.learn.liferay.com/dxp/latest/en/users-and-permissions/developer-guide/liferay-y6q4.zip -O
unzip liferay-y6q4.zip
-
cURLスクリプトを使用して、Liferayインスタンスに新規ユーザーを追加します。 コマンドラインで
curl
フォルダに移動します。User_POST_ToInstance.sh
スクリプトを実行する。./User_POST_ToInstance.sh
JSONレスポンスは、新しいUserが追加されたことを示しています。
{ "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
-
以下のコマンドで
User_POST_ToInstance
クラスを実行する:java -classpath .:* User_POST_ToInstance
コントロールパネルで、別のユーザーが追加されていることを確認します。
cURLコマンドとJavaクラスの仕組みをご覧ください。
cURLコマンドの検証
User_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クラスを調べる
User_POST_ToInstance.java
クラスは、ユーザー関連サービスを呼び出してユーザーを追加する。
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 依存情報は、インストー ルの API エクスプローラーの /o/api
にある。
main`メソッドのコメントは、クラスの実行を示している。
他のJavaクラスの例もこれと似ているが、異なる UserAccountResource
メソッドを呼び出している。
サービスの詳細については、 UserAccountResource を参照のこと。
以下は、cURLとJavaを使って、他のUser RESTサービスを呼び出す例です。
インスタンスユーザーの取得
以下のcURLとJavaのコマンドで全ユーザーのリストを取得します。
Users_GET_FromInstance.sh
コマンド:
./Users_GET_FromInstance.sh
コード:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts" \
--user "test@liferay.com:learn"
Users_GET_FromInstance.java
コマンド:
java -classpath .:* Users_GET_FromInstance
コード:
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.getUserAccountsPage(
null, null, Pagination.of(1, 2), null);
System.out.println(page);
}
JSON レスポンスには、そのインスタンスのすべてのユーザーがリストアップされます。
ユーザーの取得
以下のcURLとJavaコマンドで特定のユーザーを取得します。 1234
はあなたのユーザーIDに置き換えてください。
User_GET_ById.sh
コマンド:
./User_GET_ById.sh 1234
コード:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/${1}" \
--user "test@liferay.com:learn"
User_GET_ById.java
コマンド:
java -classpath .:* -DuserId=1234 User_GET_ById
コード:
public static void main(String[] args) throws Exception {
UserAccountResource.Builder builder = UserAccountResource.builder();
UserAccountResource userAccountResource = builder.authentication(
"test@liferay.com", "learn"
).build();
System.out.println(
userAccountResource.getUserAccount(
Long.valueOf(System.getProperty("userId"))));
}
ユーザーはJSON レスポンスで返されます。
ユーザーへのパッチ
以下のcURLとJavaコマンドで、既存ユーザーの部分編集を行います。 1234
はあなたのユーザーIDに置き換えてください。
User_PATCH_ById.sh
コマンド:
./User_PATCH_ById.sh 1234
コード:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/${1}" \
--data-raw '
{
"familyName": "Bar"
}' \
--header "Content-Type: application/json" \
--request "PATCH" \
--user "test@liferay.com:learn"
User_PATCH_ById.java
コマンド:
java -classpath .:* -DuserId=1234 User_PATCH_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.patchUserAccount(
Long.valueOf(System.getProperty("userId")),
new UserAccount() {
{
familyName = "Bar";
}
});
System.out.println(userAccount);
}
この例では、AbleとBakerの名字がFooからBarに変わっていることに注意してください。
ユーザーの配置
以下のcURLとJavaコマンドで、既存ユーザーを完全に上書きします。 1234
はあなたのユーザーIDに置き換えてください。
User_PUT_ById.sh
コマンド:
./User_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"
User_PUT_ById.java
コマンド:
java -classpath .:* -DuserId=1234 User_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に置き換えられています。
User_PATCH_ById.[java|sh]
または User_PUT_ById.[java|sh]
を使用して、status
フィールドを Active
または Inactive
に変更して、ユーザーをアクティブまたは非アクティブにすることができる。
ワークフローがアクティブなユーザーのステータスを変更するには、代わりに `headless-admin-workflow` API を使用する必要があります。使い方の詳細は [API Explorer](../../headless-delivery/consuming-apis/consuming-rest-services.md) を参照。
ユーザーの削除
以下のcURLおよびJavaコマンドで既存ユーザーを削除します。 1234
はあなたのユーザーIDに置き換えてください。
User_DELETE_ById.sh
コマンド:
./User_DELETE_ById.sh 1234
コード:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/user-accounts/${1}" \
--request "DELETE" \
--user "test@liferay.com:learn"
User_DELETE_ById.java
コマンド:
java -classpath .:* -DuserId=1234 User_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で、User関連のすべてのRESTサービスのリストを確認してください。
PostalAddresses_GET_FromUser でユーザーの郵便住所を取得する。