backlog.admin.getUsers
スペース内の全ユーザを取得します。
メソッド名
backlog.admin.getUsers
権限
「管理者」権限が必要です。
パラメータ
指定できるパラメータはありません。
レスポンス
ユーザstructの配列を返します。
ユーザstructの各フィールドの意味は下記の通りです。
| フィールド | 説明 | 例 |
|---|---|---|
| id | ユーザID | 9876 |
| user_id | ログインID | yamamoto |
| name | ハンドルネーム | やまもと |
| mail_address | メールアドレス | support@backlog.jp |
| role | 権限 |
admin : 管理者 normal-user : 一般ユーザ reporter : レポータ viewer : ビューア guest-reporter : ゲストレポータ guest-viewer : ゲストビューア |
| mail_setting | メール受信設定 | - |
| メールを受信する |
1: 受信する 0: 受信しない |
|
| └ comment | コメントメールも受信する |
1: 受信する 0: 受信しない |
| created_on | 登録日時 | 20090731151859 |
| udpated_on | 更新日時 | 20100102151848 |
リクエストXMLの例
<?xml version="1.0" encoding="utf-8"?>
<methodCall>
<methodName>backlog.admin.getUsers</methodName>
<params />
</methodCall>レスポンスXMLの例
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>id</name>
<value>
<int>9876</int>
</value>
</member>
<member>
<name>user_id</name>
<value>
<int>yamamoto</int>
</value>
</member>
<member>
<name>name</name>
<value>
<int>やまもと</int>
</value>
</member>
<member>
<name>mail_address</name>
<value>
<int>support@backlog.jp</int>
</value>
</member>
<member>
<name>role</name>
<value>
<int>normal-user</int>
</value>
</member>
<member>
<name>mail_setting</name>
<value>
<struct>
<member>
<name>mail</name>
<value><boolean>1</boolean></value>
</member>
<member>
<name>comment</name>
<value><boolean>1</boolean></value>
</member>
</struct>
</value>
</member>
<member>
<name>created_on</name>
<value>
<string>20090731151859</string>
</value>
</member>
<member>
<name>updated_on</name>
<value>
<string>20100102151848</string>
</value>
</member>
</struct>
</value>
<!-- ユーザ数くりかえし -->
</data>
</array>
</value>
</param>
</params>
</methodResponse>ＡＰＩメソッド
