ユーザー情報一覧の取得

このピースでできること

  • バクラク共通管理のユーザー情報一覧を取得します。
  • 従業員コード・メールアドレス・招待状態・アカウントの有効状態で絞り込みができます。
  • 取得する最大件数と開始位置を指定して、ページ送りしながら全件取得できます。

バクラク共通管理 の接続方法

workrun と バクラク共通管理 を接続するには、バクラク共通管理 の API キー が必要です。

ステップ 1:API キーを取得する

  1. バクラク共通管理の「管理者」権限のアカウントでバクラクにログインします。
  1. バクラク共通管理の 設定 > API 管理 を開きます。
  1. 「API キーの新規作成」 ボタンを押し、共通管理に関するスコープの中から必要なものを付与して発行します。
  1. 発行された API キー をコピーします。

ステップ 2:workrun に接続を追加する

  1. workrun で バクラク共通管理 のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「API Key」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. 従業員コード(任意)

  • 絞り込みたい従業員コードを入力します。完全一致で検索されます。
  • 空欄にすると絞り込みなしで全員を対象にします。

2. メールアドレス(任意)

  • 絞り込みたいメールアドレスを入力します。完全一致で検索されます。
  • 空欄にすると絞り込みなしで全員を対象にします。

3. 招待状態(任意)

  • 管理画面のステータスにある招待状態で絞り込みます。
  • 選択肢: (UNINVITED)/(INVITED)/(JOINED)
  • 空欄にすると絞り込みなしになります。

4. アカウントの有効状態(任意)

  • 管理画面のステータスにある有効状態で絞り込みます。
  • 選択肢: (ACTIVATED)/(DEACTIVATED)
  • 空欄にすると絞り込みなしになります。

5. 取得する最大件数(任意)

  • 1回のリクエストで取得する最大件数を指定します。1〜300の範囲で指定できます。
  • 既定値は 300 です。

6. 取得を開始する位置(任意)

  • 取得を開始する位置を0始まりで指定します。最大件数と組み合わせてページ送りができます。
  • 例: 最大件数100・開始位置0 → 1〜100件目、最大件数100・開始位置100 → 101〜200件目
  • 既定値は 0 です。