• 日本語
      • Tip

      このドキュメントはAIによって翻訳されました。不正確な情報については、英語版をご参照ください

      HTTP API を介したユーザーデータの同期

      APIキーの取得

      APIキー を参照してください。APIキーに設定されているロールが、ユーザーデータ同期に必要な権限を持っていることを確認してください。

      API概要

      例

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # リクエストボディの詳細は以下を参照してください

      エンドポイント

      POST /api/userData:push

      ユーザーデータ形式

      UserData

      パラメータ名型説明
      dataType'user' | 'department'必須。プッシュするデータの種類です。ユーザーデータをプッシュする場合は user を指定します。
      matchKey'username' | 'email' | 'phone'任意。指定されたフィールドとプッシュデータ内の対応するフィールド値に基づいて、既存のシステムユーザーを検索し、マッチングを行います。
      recordsUserRecord[]必須。ユーザーデータレコードの配列です。

      UserRecord

      パラメータ名型説明
      uidstring必須。ソースユーザーデータの一意の識別子で、ソースの元データとシステムユーザーを関連付けるために使用されます。同じユーザーに対して不変です。
      nicknamestring任意。ユーザーのニックネームです。
      usernamestring任意。ユーザー名です。
      emailstring任意。ユーザーのメールアドレスです。
      phonestring任意。携帯電話番号です。
      departmentsstring[]任意。ユーザーが所属する部門のUID配列です。
      isDeletedboolean任意。レコードが削除されたかどうかを示します。
      <field>any任意。ユーザーテーブル内のその他のカスタムフィールドデータです。

      部門データ形式

      Info

      部門データをプッシュするには、部門プラグインがインストールされ、有効になっている必要があります。

      DepartmentData

      パラメータ名型説明
      dataType'user' | 'department'必須。プッシュするデータの種類です。部門データをプッシュする場合は department を指定します。
      recordsDepartmentRecord[]必須。部門データレコードの配列です。

      DepartmentRecord

      パラメータ名型説明
      uidstring必須。ソース部門データの一意の識別子で、ソースの元データとシステム部門を関連付けるために使用されます。同じ部門に対して不変です。
      titlestring必須。部門のタイトルです。
      parentUidstring任意。親部門のUIDです。
      isDeletedboolean任意。レコードが削除されたかどうかを示します。
      <field>any任意。部門テーブル内のその他のカスタムフィールドデータです。

      :::info

      1. データの複数回プッシュは冪等です。
      2. 部門をプッシュする際に親部門がまだ作成されていない場合、関連付けはできません。その場合は、親部門の作成後に再度データをプッシュしてください。
      3. ユーザーをプッシュする際に所属部門がまだ作成されていない場合、その部門と関連付けることはできません。部門データがプッシュされた後に、再度ユーザーデータをプッシュしてください。 :::