ユーザーを追加、更新、または削除する

Garoon API ドキュメント

ユーザーを追加、更新、または削除する

固定リンクがコピーされました

ユーザーを追加する

固定リンクがコピーされました

ログイン名、名前、パスワードをリクエストのパラメーターとして受け取り、ユーザーを作成し、作成したユーザーの情報をレスポンスとして返す API です。
パスワードを指定しなかった場合は、"cybozu"が初期パスワードとして設定されます。また、パスワードに空文字を指定できません。

API名

固定リンクがコピーされました

AdminAddUserAccount

使用可能なGaroonのバージョン

固定リンクがコピーされました

パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パッケージ版 Garoon 3.1 以降

パラメーター名	型	パラメーター数	説明
login_name/text()	xsd:string	1	作成するユーザーのログイン名
display_name/text()	xsd:string	1	作成するユーザーの名前
password_raw/text()	xsd:string	0 ～ 1	作成するユーザーのパスワード
user_info	admin:UserInfoType	0 ～ 1	作成するユーザーの情報

パッケージ版 Garoon 3.0

パラメーター名	型	パラメーター数	説明
login_name/text()	xsd:string	1	作成するユーザーのログイン名
display_name/text()	xsd:string	1	作成するユーザーの名前
password_raw/text()	xsd:string	0 ～ 1	作成するユーザーのパスワード
password_salt/text()	xsd:string	0 ～ 1	ユーザーのパスワードの暗号化に使用する文字列
password_hashed/text()	xsd:string	0 ～ 1	saltとパスワードから求められるハッシュ値

例

パッケージ版 Garoon 3.1 以降

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


<parameters>
  <login_name xmlns="">user2</login_name>
  <display_name xmlns="">ユーザー2</display_name>
  <password_raw xmlns="">user2</password_raw>
  <user_info xmlns="" primary_group="1" position="2"
    sort_key="ゆーざー2" email_address="user2@sample-mail-server"
    description="メモ" post="部長" telephone_number="0000-00-0000"
    url="http://xxx" locale="1" base="2">
    <organization>1</organization>
    <organization>2</organization>
  </user_info>
</parameters>

パッケージ版 Garoon 3.0

1
2
3
4
5


<parameters> 
  <login_name xmlns="">user2</login_name> 
  <display_name xmlns="">ユーザー2</display_name> 
  <password_raw xmlns="">user2</password_raw> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名	型	パラメーター数	説明
userAccount	admin:UserDetail	0 ～ 1 0：作成されたユーザーが存在しない 1：作成されたユーザーが存在する	作成されたユーザーの情報

例

パッケージ版 Garoon 3.1 以降

1
2
3
4
5
6
7


<returns> 
  <userAccount> 
    <userId>3</userId> 
    <login_name>user2</login_name> 
    <display_name>ユーザー2</display_name> 
  </userAccount> 
</returns>

パッケージ版 Garoon 3.0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


<returns> 
  <userAccount> 
    <userId>3</userId> 
    <login_name>user2</login_name> 
    <display_name>ゆーざー2</display_name> 
    <password_raw>cybozu</password_raw> 
    <password_salt>1((d</password_salt> 
    <password_hashed>2163429666565b2d9dcbb72f7c64e53c67c3abc7</password_hashed> 
  </userAccount> 
</returns>

エラー

固定リンクがコピーされました

エラー番号	説明
GRN_CMMN_00102	Garoonにすでに存在するログイン名をlogin_nameに指定した場合

ユーザーを削除する

固定リンクがコピーされました

ユーザーID をリクエストのパラメーターとして受け取り、指定されたユーザーを削除する API です。この API は、削除したユーザーの数とユーザーID をレスポンスとして返ります。存在しないユーザーID を指定した場合、エラーは発生せず、その ID に対する処理は行いません。

API名

固定リンクがコピーされました

AdminRemoveUsersByIds

使用可能なGaroonのバージョン

固定リンクがコピーされました

パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
userId/text()	xsd:integer	1 ～無制限	削除するユーザーのID

例

1
2
3


<parameters> 
  <userId>4</userId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名	型	パラメーター数	説明
number_accounts_affected/text()	xsd:integer	1	削除されたユーザーの数
affected_userId/text()	xsd:integer	0 ～無制限 0：削除されたユーザーが存在しない	削除されたユーザーのID

例

1
2
3
4


<returns> 
  <number_accounts_affected>1</number_accounts_affected> 
  <affected_userId>4</affected_userId> 
</returns>

ユーザーを更新する

固定リンクがコピーされました

ユーザーID、ログイン名、名前、パスワードをリクエストのパラメーターとして受け取り、ユーザー情報を変更する API です。この API のレスポンスには、変更したユーザー情報が返されます。ログイン名、名前、パスワードの指定は任意で、指定した場合その情報を変更し、指定しない場合は情報の変更をしません。パスワードに空文字を指定できません。

API名

固定リンクがコピーされました

AdminModifyUserAccount

使用可能なGaroonのバージョン

固定リンクがコピーされました

パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パッケージ版 Garoon 3.1 以降

パラメーター名	型	パラメーター数	説明
userId/text()	xsd:integer	1	変更するユーザーのID
login_name/text()	xsd:string	0 ～ 1	変更するユーザーのログイン名
display_name/text()	xsd:string	0 ～ 1	変更するユーザーの名前
password_raw/text()	xsd:string	0 ～ 1	変更するユーザーのパスワード
user_info	admin:UserInfoType	0 ～ 1	変更するユーザーの情報

注：2016 年 12 月現在、不具合情報を公開するサイトに掲載のとおり、login_name と display_name については省略した場合にエラーが発生するという不具合は確認されています。

パッケージ版 Garoon 3.0

パラメーター名	型	パラメーター数	説明
userId/text()	xsd:integer	1	変更するユーザーのID
login_name/text()	xsd:string	0 ～ 1	変更するユーザーのログイン名
display_name/text()	xsd:string	0 ～ 1	変更するユーザーの名前
password_raw/text()	xsd:string	0 ～ 1	変更するユーザーのパスワード
password_salt/text()	xsd:string	0 ～ 1	パスワードを暗号化するsalt
password_hashed/text()	xsd:string	0 ～ 1	saltとパスワードから求められるハッシュ値

例

パッケージ版 Garoon 3.1 以降

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


<parameters>
  <userId xmlns="">4</userId>
  <login_name xmlns="">AB</login_name>
  <display_name xmlns="">AB</display_name>
  <user_info xmlns="" primary_group="2" position="10"
    sort_key="えーびー" email_address="user2@sample-mail-server"
    description="メモ" post="係長" telephone_number="0000-00-0000"
    url="http://xxx" locale="1" base="2">
    <organization>2</organization>
  </user_info>
</parameters>

パッケージ版 Garoon 3.0

1
2
3
4
5


<parameters> 
  <userId>4</userId> 
  <login_name>AB</login_name> 
  <display_name>AB</display_name> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名	型	パラメーター数	説明
userAccount	admin:UserDetail	1	変更されたユーザーの情報

例

パッケージ版 Garoon 3.1 以降

1
2
3
4
5
6
7


<returns> 
  <userAccount> 
    <userId>4</userId> 
    <login_name>AB</login_name> 
    <display_name>AB</display_name> 
  </userAccount> 
</returns>

パッケージ版 Garoon 3.0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


<returns> 
  <userAccount> 
    <userId>4</userId> 
    <login_name>AB</login_name> 
    <display_name>AB</display_name> 
    <password_raw>cybozu</password_raw> 
    <password_salt>1((d</password_salt> 
    <password_hashed>2163429666565b2d9dcbb72f7c64e53c67c3abc7</password_hashed> 
  </userAccount> 
</returns>

エラー

固定リンクがコピーされました

エラー番号	説明
GRN_SYSAPI_64008	指定したユーザーIDが存在しない場合

ユーザーを組織に所属させる

固定リンクがコピーされました

ユーザーID と、そのユーザーが新たに所属する組織の ID をリクエストのパラメーターとして受け取り、設定を変更したユーザーと組織の情報をレスポンスとして返す API です。
AdminAddUsersToOrg と異なり、この API は一人のユーザーに対して複数の組織を指定できます。

API名

固定リンクがコピーされました

AdminSetOrgsOfUser

使用可能なGaroonのバージョン

固定リンクがコピーされました

パッケージ版 Garoon 3.0 以降

リクエスト

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
userId/text()	xsd:integer	1	設定を変更するユーザーのID
orgId/text()	xsd:integer	1 ～無制限	ユーザが新たに所属する組織のID

例

1
2
3
4
5
6


<parameters> 
  <userId>20</userId> 
  <orgId>489</orgId> 
  <orgId>428</orgId> 
  <orgId>367</orgId> 
</parameters>

レスポンス

固定リンクがコピーされました

API 名とレスポンスの要素名が異なります。

パラメーター名	型	パラメーター数	説明
number_relationships_affected/text()	xsd:integer	1	ユーザーが新たに所属した組織の数
affected_userId/text()	xsd:integer	1	設定が変更されたユーザーのID
affected_orgId/text()	xsd:integer	0 ～無制限	ユーザーが新たに所属した組織のID

例

1
2
3
4
5
6
7
8
9


<returns> 
  <number_relationships_affected> 
    3 
  </number_relationships_affected> 
  <affected_userId>20</affected_userId> 
  <affected_orgId>367</affected_orgId> 
  <affected_orgId>428</affected_orgId> 
  <affected_orgId>489</affected_orgId> 
</returns>

Garoon API ドキュメント