backlog.admin.addUser｜API｜開発者向け｜どこでもプロジェクト管理バックログ

メソッド名

backlog.admin.addUser

権限

「管理者」権限が必要です。

パラメータ

structの要素に下記パラメータが指定できます。

backlog.admin.addUserパラメーター
パラメータ名	型	内容
user_id (必須)	string	ユーザID(ログインID)
password_md5 (必須)	string	パスワードのMD5ハッシュ値(16進数表記)
name (必須)	string	ハンドルネーム
mail_address (必須)	string	メールアドレス
role (必須)	string	権限 admin : 管理者 normal-user : 一般ユーザ reporter : レポータ viewer : ビューア guest-reporter : ゲストレポータ guest-viewer : ゲストビューア
mail_setting	struct	メール設定
├ mail	boolean	1: 受信する 0: 受信しない
└ comment	boolean	1: 受信する 0: 受信しない
icon	struct	ユーザアイコン
├ type	string	アイコンの種類 backlog : Backlog提供アイコン original: オリジナル画像
└ data	string または base64	typeがbacklogの場合はアイコン名 ( ユーザアイコン一覧を参照 ) , typeがoriginalの場合は画像データ

レスポンス

追加したユーザstructを返します。
ユーザstructの各フィールドの意味は下記の通りです。

backlog.admin.addUser レスポンスフィールド
フィールド	説明	例
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	メール受信設定	-
├ mail	メールを受信する	1: 受信する 0: 受信しない
└ comment	コメントメールも受信する	1: 受信する 0: 受信しない
created_on	登録日時	20090731151859
udpated_on	更新日時	20100102151848

リクエストXMLの例

<?xml version="1.0" encoding="utf-8"?>
<methodCall>
  <methodName>backlog.admin.addUser</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>user_id</name>
            <value>
              <string>yamamoto</string>
            </value>
          </member>
          <member>
            <name>password_md5</name>
            <value>
              <string>5f4dcc3b5aa765d61d8327deb882cf99</string>
            </value>
          </member>
          <member>
            <name>name</name>
            <value>
              <string>やまもと</string>
            </value>
          </member>
          <member>
            <name>mail_address</name>
            <value>
              <string>support@backlog.jp</string>
            </value>
          </member>
          <member>
            <name>role</name>
            <value>
              <string>normal-user</string>
            </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>icon</name>
            <value>
              <struct>
                <member>
                  <name>type</name>
                  <value><string>backlog</string></value>
                </member>
                <member>
                  <name>data</name>
                  <value><string>animal_006</string></value>
                </member>
              </struct>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </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>

ユーザアイコン一覧

ユーザの追加/更新で"Backlog提供アイコン"として以下のアイコン名を指定できます。

ユーザアイコン一覧
パラメータ値	アイコン画像
00_default
01_salaried_man
02_female_office_worker
03_career_woman
04_female_programmer
04_male_programmer
05_female_designer
05_male_designer
06_artist
07_bandsman
08_boss
09_civil_officer
10_metabolic_syndrome_salaried_man
11_tired_salaried_man
12_macho_man
13_woman_with_arts
14_mother
15_father
16_american
17_english
18_indian
19_african
20_samurai
21_knight
22_pierrot
23_surfer
24_pastry_chef
25_sommelier
26_schoolmistress
27_secretary
28_deek
29_detective
30_gorilla
31_robot
32_letter_carrier
33_cactus
34_landscape1
35_landscape2
36_landscape3
37_landscape4