Garoon APIドキュメント

ユーザー情報を取得する

目次

GaroonユーザーIDを取得する

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

取得するユーザーの数と取得開始するユーザーのオフセットをリクエストのパラメーターとして受け取り、GaroonユーザーIDの一覧を取得するAPIです。
このAPIは、取得したユーザーの数とGaroonユーザーIDをレスポンスとして返ります。パラメーターを指定しない場合、すべてのユーザーを取得して、返ります。

API名

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

AdminGetUserIds

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
offset/text() xsd:integer 0～1
  • 0：オフセットが指定されていない
  • 1：オフセットが指定されている
 取得開始するユーザーのオフセット
limit/text() xsd:integer 0～1
  • 0：上限が指定されていない
  • 1：上限が指定されている
 取得するユーザー数の上限
例
1
2
3
4

<parameters>
  <offset xmlns="">5</offset>
  <limit xmlns="">10</limit>
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
number_users/text() xsd:integer 1 取得したユーザーの数
userId/text() xsd:integer 0～ 無制限
  • 0：ユーザーが存在しない
 GaroonユーザーID
例
1
2
3
4
5
6

<returns> 
  <number_users>3</number_users> 
  <userId>6</userId> 
  <userId>7</userId> 
  <userId>8</userId> 
</returns>

ユーザー情報を取得する

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

GaroonユーザーIDをリクエストのパラメーターとして受け取り、ユーザー情報をレスポンスとして返すAPIです。
存在しないGaroonユーザーIDを指定した場合、エラーは発生せず、そのIDに対する処理は行いません。 ユーザー情報のその他の項目値を取得する場合は、ベースAPIの BaseGetUsersById を使用します。

API名

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

AdminGetUserDetailByIds

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
userId/text() xsd:integer 1～ 無制限 取得するGaroonユーザーID
例
1
2
3
4

<parameters> 
  <userId>1</userId> 
  <userId>2</userId> 
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
number_users/text() xsd:integer 1 取得したユーザー情報の数
userDetail admin:UserDetail 0～ 無制限
  • 0：ユーザーが存在しない
 ユーザー情報
例
クラウド版Garoon、パッケージ版Garoon 3.1以降
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<returns> 
  <number_users>2</number_users> 
  <userDetail> 
    <userId>1</userId> 
    <login_name>Administrator</login_name> 
    <display_name>Administrator</display_name> 
  </userDetail> 
  <userDetail> 
    <userId>2</userId> 
    <login_name>A1</login_name> 
    <display_name>A1</display_name> 
  </userDetail> 
</returns>
パッケージ版Garoon 3.0
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

<returns> 
  <number_users>2</number_users> 
  <userDetail> 
    <userId>1</userId> 
    <login_name>Administrator</login_name> 
    <display_name>Administrator</display_name> 
    <password_salt>\]HG\`</password_salt> 
    <password_hashed>4a3669158c91d4d9bab772b93f0da62a0764d474</password_hashed> 
  </userDetail> 
  <userDetail> 
    <userId>2</userId> 
    <login_name>A1</login_name> 
    <display_name>A1</display_name> 
    <password_salt>.x.#</password_salt> 
    <password_hashed>c9b73beacef858f3132a8747533002b75048d9f3</password_hashed> 
  </userDetail> 
</returns>

ユーザー数を取得する

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

Garoonに存在するユーザー数をレスポンスとして返すAPIです。

API名

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

AdminCountUsers

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

なし

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
number_users/text() xsd:integer 0～1
  • 0：ユーザーが存在しない
  • 1：ユーザーが存在する
 ユーザー数
例
1
2
3

<returns> 
  <number_users>3</number_users> 
</returns>

組織内のユーザー数を取得する

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

組織IDをリクエストのパラメーターとして受け取り、組織内に存在するユーザーの人数をレスポンスとして返すAPIです。
存在しない組織IDを指定した場合、レスポンスのorgIdには-1が入り、number_usersは0が入ります。

API名

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

AdminCountUsersInOrg

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
例
1
2
3

<parameters> 
  <orgId>2</orgId> 
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
number_users/text() xsd:integer 1 組織内に存在するユーザー数
例
1
2
3
4

<returns> 
  <orgId>2</orgId> 
  <number_users>9</number_users> 
</returns>

組織内のGaroonユーザーIDを取得する

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

組織IDをリクエストのパラメーターとして受け取り、組織内に存在するGaroonユーザーIDをレスポンスとして返すAPIです。
存在しない組織IDを指定した場合、レスポンスのorgIdには -1が入り、number_usersは0が入ります。

API名

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

AdminGetUserIdsInOrg

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
offset/text() xsd:integer 0～1 オフセット
limit/text() xsd:integer 0～1 取得するユーザーの上限数
例
1
2
3
4
5

<parameters> 
  <orgId>2</orgId> 
  <offset>0</offset> 
  <limit>10</limit> 
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
number_users/text() xsd:integer 1 取得したユーザー数
userId/text() xsd:integer 0～ 無制限 取得したGaroonユーザーID
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<returns> 
  <orgId>2</orgId> 
  <number_users>9</number_users> 
  <userId>2</userId> 
  <userId>3</userId> 
  <userId>4</userId> 
  <userId>5</userId> 
  <userId>6</userId> 
  <userId>7</userId> 
  <userId>8</userId> 
  <userId>9</userId> 
  <userId>10</userId> 
</returns>

組織に未所属のユーザー数を取得する

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

どの組織にも属していないユーザーの人数をレスポンスとして返すAPIです。

API名

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

AdminCountNoGroupUsers

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

なし

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
number_users/text() xsd:integer 1 組織に未所属のユーザー数
例
1
2
3

<returns> 
  <number_users>30<number_users> 
</returns>

組織に未所属のGaroonユーザーIDを取得する

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

どの組織にも属していないGaroonユーザーIDをレスポンスとして返すAPIです。

API名

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

AdminGetNoGroupUserIds

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

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

パラメーター名 型 パラメーター数 説明
offset/text() xsd:integer 0～1 オフセット
limit/text() xsd:integer 0～1 取得するユーザーの上限数
例
1
2
3
4

<parameters> 
  <offset>0</offset> 
  <limit>10</limit> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
number_uisers/text() xsd:integer 1 取得したユーザーの数
userId/text() xsd:integer 0～ 無制限 組織に未所属のGaroonユーザーID
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

<returns> 
  <number_users>10</number_users> 
  <userId>1</userId> 
  <userId>11</userId> 
  <userId>12</userId> 
  <userId>13</userId> 
  <userId>14</userId> 
  <userId>15</userId> 
  <userId>16</userId> 
  <userId>17</userId> 
  <userId>18</userId> 
  <userId>19</userId> 
</returns>

ユーザーが所属している組織数を取得する

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

GaroonユーザーIDをリクエストのレスポンスとして受け取り、ユーザーが所属している組織の数をレスポンスとして返すAPIです。

API名

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

AdminCountOrgsOfUser

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

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

パラメーター名 型 パラメーター数 説明
userId/text() xsd:integer 1 GaroonユーザーID
例
1
2
3

<parameters> 
  <userId>2</userId> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
userId/text() xsd:integer 1 GaroonユーザーID
number_orgs xsd:integer 1 所属する組織数
例
1
2
3
4

<returns> 
  <userId>1</userId> 
  <number_orgs>10</number_orgs> 
</returns>

ユーザーが所属している組織のIDを取得する

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

GaroonユーザーIDをリクエストのレスポンスとして受け取り、ユーザーが所属している組織のIDをレスポンスとして返すAPIです。

API名

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

AdminGetOrgIdsOfUser

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
userId/text() xsd:integer 1 GaroonユーザーID
例
1
2
3

<parameters> 
  <userId>2</userId> 
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
userId/text() xsd:integer 1 GaroonユーザーID
number_orgs xsd:integer 1 所属する組織の数
orgId xsd:integer 0～ 無制限 所属する組織のID
例
1
2
3
4
5
6

<returns> 
  <userId>1</userId> 
  <number_orgs>2</number_orgs> 
  <orgId>2</orgId> 
  <orgId>3</orgId> 
</returns>

ログイン名からGaroonユーザーIDを取得する

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

ログイン名をリクエストのレスポンスとして受け取り、GaroonユーザーIDをレスポンスとして返すAPIです。
存在しないログイン名を指定した場合、-1が返されます。

API名

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

AdminGetUserIdByLoginName

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

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

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

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

パラメーター名 型 パラメーター数 説明
login_name/text() xsd:string 1 ログイン名
例
1
2
3

<parameters> 
  <login_name>user1</login_name> 
</parameters>

レスポンス

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

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

パラメーター名 型 パラメーター数 説明
login_name/text() xsd:string 1 指定したログイン名
userId/text() xsd:integer 1 GaroonユーザーID
例
1
2
3
4

<returns> 
  <login_name>user1</login_name> 
  <userId>2</userId> 
</returns>