カテゴリー内の他の記事

ユーザー情報を取得する

フォローする

Index

ユーザー情報を取得する

ユーザーID をリクエストのパラメーターとして受け取り、ユーザー情報をレスポンスとして返す API です。 ユーザー情報の項目のうち、システム管理者が非公開に設定したもの、およびカスタマイズ項目は取得できません。 なお、Garoon on cybozuではカスタマイズ項目以外のユーザー情報の項目を非公開にすることはできません。

API名

BaseGetUsersById

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

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

リクエスト

パラメーター名 パラメーター数 説明
user_id/text() base:IDType 1 ~ 無制限 情報取得するユーザーのID

<parameters xmlns=""> 
  <user_id>1</user_id> 
  <user_id>2</user_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
user base:UserType 1 ~ 無制限 取得したユーザの情報

<returns> 
  <userkey="1" version="1245376338" order="0" login_name="Administrator" 
   name="Administrator" status="0" />  
  <user key="2" version="1245919830" order="1" login_name="u1" name="u1"  
   status="0" reading="user1" url="http://cybozu.co.jp" email="user1@cybozu.co.jp"  
   phone="9180xxxxxx" description="user1 is ..." title="test test"  
   primary_organization="2"> 
    <photo file_id="2" version="1245919830" name="8.jpg" size="18741"  
     mime_type="image/jpeg" />  
    <organization id="2" />  
    <organization id="6" />  
  </user> 
</returns>

エラー

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

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

ログイン名をリクエストのパラメーターとして受け取り、ユーザー情報をレスポンスとして返す API です。 ユーザー情報の項目のうち、システム管理者が非公開に設定したもの、およびカスタマイズ項目は取得できません。 なお、Garoon on cybozuではカスタマイズ項目以外のユーザー情報の項目を非公開にすることはできません。

API名

BaseGetUsersByLoginName

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

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

リクエスト

パラメーター名 パラメーター数 説明
login_name/text() base:NonBlankStringType 1 ~ 無制限 情報取得するユーザーのログイン名

<parameters> 
  <login_name>Administrator</login_name>  
  <login_name>saito</login_name>  
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
user base:UserType 1 ~ 無制限 取得したユーザの情報

<returns> 
  <user key="1" version="1245376338" order="0" login_name="Administrator" 
   name="Administrator" status="0" />  
  <user key="2" version="1245919830" order="1" login_name="u1" name="u1"  
   status="0" reading="user1" url="http://cybozu.co.jp" email="user1@cybozu.co.jp"  
   phone="9180xxxxxx" description="user1 is ..." title="test test"  
   primary_organization="2"> 
    <photo file_id="2" version="1245919830" name="8.jpg" size="18741"  
     mime_type="image/jpeg" />  
    <organization id="2" />  
    <organization id="6" />  
  </user> 
</returns>

エラー

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

ユーザーの更新情報を取得する

ユーザーの ID と version をリクエストのパラメーターとして受け取り、ユーザーの更新情報を返す API です。

API名

BaseGetUserVersions

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

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

リクエスト

パラメーター名 パラメーター数 説明
user_item base:ItemVersionType 0 ~ 無制限
  • 0:ユーザーのバージョンが指定されていない
更新情報を取得するユーザーのIDとバージョン

<parameters> 
  <user_item id="1" version="11" />  
  <user_item id="2" version="22" />  
  <user_item id="3" version="33" />  
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
user_item base:ItemVersionResultType 0 ~ 無制限
  • 0:ユーザーの更新情報が無い
取得したユーザーの更新情報

<returns> 
  <user_item id="1" version="1245376338" operation="modify" />  
  <user_item id="2" version="1245327097" operation="modify" />  
  <user_item id="3" version="1245327110" operation="modify" />  
  <user_item id="4" version="1245715417" operation="add" />  
  <user_item id="5" version="1245715429" operation="add" />  
</returns>

 

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

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

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