ユーザのCSVファイルの記述について
ユーザのインポートで利用するCSVファイルの記述方法を説明します。
CSVファイルに記載可能な項目
CSVヘッダ名 | 必須 | 内容 | 説明 | 入力例 |
---|---|---|---|---|
login_id | ○ | ID | ユーザのIDをメールアドレス形式で入力します 指定されたIDが存在しない場合、ユーザを新規作成します。存在する場合は、ユーザ情報を更新します CSVファイル内で重複する値は指定できません | iij-taro@example.jp |
is_active | 有効 / 無効 | "true"(有効)または "false"(無効)を入力します デフォルト: true | true | |
通知先メールアドレス | ユーザの通知先メールアドレスを入力します ユーザの新規作成時に未指定の場合は、login_id が通知先メールアドレスとなります | iij-taro.mail@example.jp | ||
family_name | 姓 | ユーザの姓を入力します | IIJ | |
family_name_yomi | 姓(カナ) | ユーザの姓をカタカナで入力します | アイアイジェイ | |
given_name | 名 | ユーザの名を入力します | 太郎 | |
given_name_yomi | 名(カナ) | ユーザの名をカタカナで入力します | タロウ | |
title | 役職 | ユーザの役職を入力します | 総務部 | |
department | 所属 | ユーザの所属を入力します | 主任 | |
preferred_language | 言語 | "ja_JP"(日本語)または "en_US"(英語)を入力します デフォルト: "ja_JP" | ja_JP | |
byod_email | 個人通知先メールアドレス | ユーザの個人通知先メールアドレスを入力します メールが受信できるアドレスを指定してください | iij-taro.mobile@example.jp | |
byod_phone_number | 個人携帯電話番号 | RFC 3966に準拠した電話番号を入力します | tel: +819000000000 | |
entitlement | entitlement | entitlementを入力します entitlementは、連携するサービス側での資格情報などとして利用することがあります。サービスごとに固有の値を入力することが求められます ※CSVインポートでは、entitlementは複数登録できません。entitlementを複数登録する場合はユーザの編集画面から登録してください | ||
delete_flag | ユーザを削除待ちにするか | ユーザを削除待ちにします "true"(削除待ちにする)または "false"(削除待ちにしない)を入力します デフォルト: false | false | |
update_only_flag | ユーザ更新のみ許可するか | CSVインポートによってユーザの作成・削除が行われないようにします "true"(許可する)または "false"(許可しない)を入力します デフォルト: false | false | |
downstream_id | アプリケーション連携ID | Microsoft 365との認証連携及びエクスポートで利用します。ID連携及び認証連携ができなくなる可能性があります 設定時の影響が分からない場合は、値を新規に設定、及び既存の値から変更を行わないでください。詳しくは、「ユーザの編集」をご覧ください | 空(不明な場合)、 または DOWNSTREAM_ID |
【参考】
- CSVファイルの1行目には、必ず、ヘッダ行(「▼記述例」の1行目)を記述してください。
- 必須以外の項目は、登録の必要がなければCSVファイルへの記載を省略できます。その場合は、1行目のヘッダ行から該当の項目を削除し、2行目以降も同項目の情報を記述しないでください。
- 項目の順番は変更できます。1行目のヘッダの項目の順番を変更し、以降の行の項目もヘッダ行と同じ順番で記載してください。
- 文字コードはSHIFT-JISに対応しています。
- 50MBまでのサイズのCSVファイルをインポートできます。
- アカウントの削除のみを行う場合はlogin_idとdelete_flagのみを記載します。
【注意】
外部ユーザストアからインポートされたユーザは、CSVインポートで更新できません。これらのユーザがCSVファイル内に含まれる場合はCSVインポートがエラーとなり、同期していないユーザを含むすべてのユーザのインポートが行われません。
CSVファイルのアップロードに成功した場合でも、CSVファイルの記述などに問題がある場合はユーザのインポートに失敗します。インポートに成功したかを確認するには、該当ジョブのステータスをご覧ください。ジョブの確認方法については、「ジョブの閲覧」をご覧ください。
CSVファイルの記述例
▼記述例(はEnterキーの入力を意味します) login_id,is_active,email,family_name,family_name_yomi,given_name,given_name_yomi,title,department,preferred_language,byod_email,byod_phone_number,entitlement,delete_flag,update_only_flag,downstream_id |