ユーザー情報をインポートする

CSV ファイルを使って、ユーザー情報の差分をインポートします。
インポートするユーザー情報の CSV ファイルのフォーマットは、ユーザー情報 CSV を参照してください。

JSON 形式で更新する API の詳細は、次のページを参照してください。

https://sample.cybozu.com/v1/csv/user.json

POST

パラメーター名	型	必須	説明
fileKey	文字列	必須	CSV ファイルをアップロードする API で取得したファイルキー
variableCustomItemLength	真偽値	省略可	カスタマイズ項目値に過不足があってもインポートを成功させるかどうか `true`：成功させる `false`：失敗させる省略すると「false」が設定されます。「false」を設定している場合に、CSV にカスタマイズ項目に相当する列が足りないと、カスタマイズ項目の順番どおりにインポートされます。カスタマイズ項目に相当する列が足りずに値が指定されていない項目は、元のデータが維持されます。カスタマイズ項目に相当する列が多すぎると、超過した列は無視されてインポートされます。

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は User API の共通仕様を参照してください。

1
2
3
4


{
  "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",
  "variableCustomItemLength": true
}

プロパティ名	型	説明
id	数値	実行結果の ID 処理内容を確認するには、インポートの結果を確認する API を実行します。

1
2
3


{
  "id": 1
}

「ログイン名」の値が空欄のデータは、更新および削除されません。
CSV ファイルの項目の値は、Unicode 正規化されます。そのため、旧漢字は利用できません。
たとえば、旧漢字の「神」をインポートすると、「神」に変換されて登録されます。

cybozu.com 共通 API ドキュメント