メインコンテンツまでスキップ

GetUserInfoByAdmin

ユーザーの関連情報を取得する（ワークスペース管理者専用）

Description​

  • ワークスペース管理者のみ利用可能です。
  • emailなどユーザーが特定できる条件を指定して1ユーザーの情報を取得します

Method​

GET

Request URL Format​

/api/v0/users/userinfo

Params​

Request URL Sample​

GET https://api.xxx.com/api/v0/users/[email protected]

Payload​

Content-Type : application/json

（例）emailを指定して取得

{
  "email": "[email protected]",  // User's email address registered in Hexabase
  "exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // （任意）ワークスペース限定ユーザとして登録したユーザ情報を取得する場合に対象のワークスペースIDを指定します
}

（例）user_codeを指定して取得

{
  "user_code": "sample",
  "exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // （任意）ワークスペース限定ユーザとして登録したユーザ情報を取得する場合に対象のワークスペースIDを指定します
}

Response Sample​

{
    "u_id": "対象ユーザーID",
    "username": "対象ユーザー名",
    "email": "[email protected]",
    "profile_pic": "対象ユーザーのプロファイル画像の保存先",
    "confirmed": true,  //("bool, このユーザーが確認済みかどうか")
    "email_sent": true, //("bool, このユーザーにemailが送られたかどうか")
    "user_roles": [
      {
        "r_id": "システム内部のロールID",
        "role_name": "ロール名ID１",
        "role_id": "画面で入力されたロールID",
        "p_id": "プロジェクトID1",
        "application_id": "アプリケーションID",
        "application_name": "アプリケーション名",
        "application_display_order": 0
      },
      {
        "r_id": "5e3ac99c393da500077068b0",
        "role_name": "部長",
        "role_id": "Manager1",
        "p_id": "5e015f03285ab60007442e5e",
        "application_id": "xxSystem",
        "application_name": "バツバツシステム",
        "application_display_order": 0
      }
    ],
    "user_code": "sample"
}