ユーザ更新
概要¶
APIを使用してユーザを更新することができます。
事前準備¶
APIの操作を行う前にAPIキーの作成を実施してください。
また、この機能はテナント管理者でないと行えないため、ユーザ管理からテナント管理者の設定を行ってください。
リクエスト¶
下記のリクエスト形式で、jsonデータを送信します。
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | http://{サーバ名}/api/users/{ユーザID}/update(※1) |
| Body | 以下のjsonデータを参考のこと |
(※1){サーバ名}、{ユーザID}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https://pleasanter.net/fs/api/users/{ユーザID}/update
設定値¶
設定値はスクリプトの$p.apiUsersUpdateでも指定できます。
| パラメータ名 | 型 | 必須 | 概要 |
|---|---|---|---|
| ApiVersion | decimal | APIのバージョン。 | |
| ApiKey | string | ○1 | 事前に作成したAPIキー。 |
| JSONデータレイアウト | object | ○ | 更新するユーザの情報。詳細は「JSONデータレイアウト:User」を参照 |
JSON¶
{
"ApiVersion": 1.1,
"ApiKey": "8s63Aiigd98h51Dfda7951...",
"Name": "[更新後のユーザーの名前]",
"MailAddresses": [
"webmaster@example.com",
"info@example.com"
],
"ClassHash": {
"ClassA": "test-class-column"
},
"NumHash": {
"NumA": 100
},
"DateHash": {
"DateA": "2026-08-19"
},
"DescriptionHash": {
"DescriptionA": "補足説明"
},
"CheckHash": {
"CheckA": true
}
}
※メールアドレスを更新する場合はMailAddressesにリスト形式で記述します(任意)。1つのユーザに対して単一または複数のメールアドレスを設定することが可能です。洗い替え方式で更新されます(古いメールアドレス情報を削除して新しいメールアドレス情報を追加する)。
レスポンス¶
下記の形式のjsonデータが返却されます。
JSON¶
メールアドレスの設定について¶
以下のようにMailAddressesのパラメータを指定した上でリストを空にした場合はメールアドレスが削除されます。
JSON¶
{
"ApiVersion": 1.1,
"ApiKey": "8s63Aiigd98h51Dfda7951...",
"Name": "[更新後のユーザーの名前]",
"MailAddresses": [
]
}
以下のようにMailAddressesのパラメータを指定しない場合はメールアドレスは更新(削除)されません。
JSON¶
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.3.22.0 以降 | メールアドレスをAPIで更新する機能を追加 |
| 1.5.8.0 以降 | 拡張項目をAPIで更新する機能を追加 |
エラー時の確認事項¶
・API使用時の注意点やエラーが発生する場合の確認事項
・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項
仕様変更について¶
※ 2018年11月よりAPIの仕様が一部変更となりました。
- URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。
- Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。
-
APIキーはAPIでは指定必須。スクリプトおよびサーバスクリプトは任意指定で、指定した場合はAPIキーのユーザの権限で処理を実行。 ↩
