ユーザ情報削除
ユーザ情報を削除します。
(1) 必要な権限
DeleteUserInformation APIを使用するには以下の権限が必要です。
-
システム管理の削除権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
任意のユーザの情報を削除可能
- グループ単位
-
管理対象グループに所属するユーザの情報のみ削除可能
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/DeleteUserInformation
(3) リクエストインタフェース
項目名 |
説明 |
文字 |
省略 |
省略値 |
---|---|---|---|---|
group_id |
グループID (*1) グループIDを32バイト以内で指定します。 カンマ区切りによる複数指定可。ただし、group_idを複数指定した場合は、user_idは指定不可。 例)group_id="testGoup1,testGroup2" |
半角 |
× |
|
user_id |
ユーザID (*1) ユーザIDを32バイト以内で指定します。 カンマ区切りによる複数指定可。ただし、user_idを複数指定した場合は、group_idは単一指定のみ可。 例)user_id="testUser1,testUser2" |
半角 |
○ |
ブランク グループ単位で削除 |
*1 |
: |
「system_service」、「everyone」、「unknown」以外の値を指定します。 |
(4) レスポンスインタフェース
項目名 |
説明 |
備考 |
---|---|---|
info_user |
ユーザ情報 正常に削除したユーザのグループID、ユーザIDが単一または複数返却されます。 |
*1 |
*1 |
: |
XMLフォーマットで返されます。形式は以下のとおりです。 <info_user> <group_id>XXX</group_id> <user_id>aaa</user_id> </info_user> <info_user> <group_id>XXX</group_id> <user_id>bbb</user_id> </info_user> |