Users API――情報更新
管理者はこのAPIで、全ユーザーの情報を編集できます。その他のユーザーは、自分のパスワードとメール アドレスを変更できます。
リクエスト サンプル
XMLでレスポンスを受けるには:http://[APM Host]:[APM Port]/AppManager/xml/Users/update?apikey=[API_KEY]&userId=[ID]&userName=[NAME]&role=[ROLE]&password=[PASS_WORD]
JSONでレスポンスを受けるには:http://[APM Host]:[APM Port]/AppManager/json/Users/update?apikey=[API_KEY]&userId=[ID]&userName=[NAME]&role=[ROLE]&password=[PASS_WORD]
管理者向けリクエスト パラメーター
フィールド | 説明 |
---|---|
userId | 更新するユーザーをIDで指定します。指定がなければ、デフォルトで特定APIオーナーのIDを採用します。 |
userName | ユーザー名を指定します。ただし、デフォルトの「admin」のユーザー名は変更できません。 |
role | 新規ユーザーのユーザー グループを指定します。ただし、デフォルトの「admin」のロールは変更できません。 |
password | ユーザーの新規パスワードです。 |
oldPassword | ユーザーの旧パスワードです。 |
ユーザーのメール アドレスです。 | |
description | ユーザーの説明です。 |
associateGroupId | ユーザーを関連付ける監視グループをグループIDで指定します。グループIDはカンマ区切りにしてください。 |
associateGroupName | ユーザーを関連付ける監視グループの名前です。groupIdの指定があれば、このパラメーターは無視します。 |
removeGroupId | ユーザー削除元とする監視グループのグループIDを指定します。グループIDはカンマ区切りにしてください。 |
removeGroupName | ユーザー削除元とする監視グループです。groupIdの指定があれば、このパラメーターは無視します。 |
*この記号の付いたパラメータは任意項目です。
一般ユーザー向けリクエスト パラメーター
フィールド | 説明 |
---|---|
password | ユーザーの新規パスワードです。 |
oldPassword | ユーザーの旧パスワードを指定します。パスワード更新を行う場合は、指定が必須です。 |
ユーザーのメール アドレスです。 |
サンプル レスポンス
<AppManager-response uri="/AppManager/xml/users/create"><result>
<response response-code="4000">
<User email="manager" userId="6" description="manager" userName="manager" role="MANAGER">
<AssociatedGroups groupId="10000035" groupName="Applications Manager"/>
<AssociatedGroups groupId="10000037" groupName="mg1"/>
<AssociatedGroups groupId="10000038" groupName="mg2"/>
</User>
</response>
</result>
</AppManager-response>
<response response-code="4000">
<User email="manager" userId="6" description="manager" userName="manager" role="MANAGER">
<AssociatedGroups groupId="10000035" groupName="Applications Manager"/>
<AssociatedGroups groupId="10000037" groupName="mg1"/>
<AssociatedGroups groupId="10000038" groupName="mg2"/>
</User>
</response>
</result>
</AppManager-response>