ユーザー情報を取得する

フォローする

Index

ユーザーIDを取得する

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

API名

AdminGetUserIds

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

パラメーター名 パラメーター数 説明
number_uisers/text() xsd:integer 1 取得したユーザーの数
userId/text() xsd:integer 0 ~ 無制限
  • 0:ユーザーが存在しない
ユーザーID
<returns> 
  <number_users>3</number_users> 
  <userId>6</userId> 
  <userId>7</userId> 
  <userId>8</userId> 
</returns>

ユーザー情報を取得する

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

API名

AdminGetUserDetailByIds

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 ~ 無制限 取得するユーザーのID

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

レスポンス

パラメーター名 パラメーター数 説明
number_users/text() xsd:integer 1 取得したユーザー情報の数
userDetail admin:UserDetail 0 ~ 無制限
  • 0:ユーザーが存在しない
ユーザー情報

Garoon on cybozu、パッケージ版 バージョン 3.1.0以降

<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>

パッケージ版 バージョン 3.0.x

<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>

ユーザー数を取得する

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

API名

AdminCountUsers

リクエスト

なし

レスポンス

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

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

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

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

API名

AdminCountUsersInOrg 使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

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

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

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

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

API名

AdminGetUserIdsInOrg

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

パラメーター名 パラメーター数 説明
orgId/text() xsd:integer 1 組織ID
number_users/text() xsd:integer 1 取得したユーザー数
userId/text() xsd:integer 0 ~ 無制限 取得したユーザーのID

<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 on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

なし

レスポンス

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

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

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

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

API名

AdminGetNoGroupUserIds

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

パラメーター名 パラメーター数 説明
number_uisers/text() xsd:integer 1 取得したユーザーの数
userId/text() xsd:integer 0 ~ 無制限 組織に未所属のユーザーID

<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>

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

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

API名

AdminCountOrgsOfUser

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

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

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

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

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

API名

AdminGetOrgIdsOfUser

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

パラメーター名 パラメーター数 説明
userId/text() xsd:integer 1 ユーザーID
number_orgs xsd:integer 1 所属する組織の数
orgId xsd:integer 0 ~ 無制限 所属する組織のID

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

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

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

API名

AdminGetUserIdByLoginName

使用可能なガルーンのバージョン

  • Garoon on cybozu
  • パッケージ版 バージョン 3.0.0以降

リクエスト

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

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

レスポンス

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

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

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk