Description of User CSV File
This section describes how to describe a CSV file used to import users.
Items that can be described in the CSV file
| CSV header name | Required | Content | Description | Example Entry |
|---|---|---|---|---|
| login_id | Yes | ID | Enter the user ID in email address format. A new user is created if the specified ID does not already exist. User information is updated if the ID does exist. Duplicate values cannot be specified in CSV files. | iij-taro@example.jp |
| is_active | Enabled/Disabled | Enter "true" (enabled) or "false" (disabled). Default: true | true | |
| Notification email address | Enter the user's notification email address. If this is not specified when a new user is created, the login_id value will be used as the notification email address. | iij-taro.mail@example.jp | ||
| family_name | Last name | Enter the last name of the user. | IIJ | |
| family_name_yomi | Last name (kana) | Enter the last name of the user in katakana. | アイアイジェイ | |
| given_name | First name | Enter the last name of the user. | Taro | |
| given_name_yomi | First name (kana) | Enter the first name of the user in katakana. | タロウ | |
| title | Position | Enter the user's position. | General Affairs | |
| department | Department | Enter the department to which the user belongs. | Manager | |
| preferred_language | Language | Enter "ja_JP" (Japanese) or "en_US" (English). Default: "ja_JP" | ja_JP | |
| byod_email | Personal notification email address | Enter the user's personal notification email address. Specify a valid address that can receive email. | iij-taro.mobile@example.jp | |
| byod_phone_number | Personal mobile phone number | Enter a phone number compliant with RFC 3966. | tel: +819000000000 | |
| entitlement | entitlement | Enter the entitlement. Entitlements can be used as credentials information by federated services. Enter values that are unique to each service. * Multiple entitlements cannot be registered by importing CSV data. Use the user edit screen to register multiple entitlements. | ||
| delete_flag | Determines whether to designate a user as pending deletion | Designates a user as pending deletion. Enter "true" (designate as pending deletion) or "false" (do not designate as pending deletion). Default: false | false | |
| update_only_flag | Determines whether to allow user updates only | Prevents user creation and deletion by importing CSV data. Enter "true" (allow) or "false" (do not allow). Default: false | false | |
| downstream_id | Application-linking ID | Use the application federation ID for federation with Microsoft 365 and export. There is a possibility that ID federating and federation can no longer be established If the influence at the time of configuration is unknown, do not set new values and change the existing values. Refer to "Editing Users" for more information. | Empty (when unknown) or DOWNSTREAM_ID |
[ Reference ]
- The first row of CSV files must contain the header row (see first row in the example description).
- Optional parameters can be omitted from CSV files. To do so, delete the optional parameter from the header (first) row, and omit the description of information in the second and subsequent rows.
- The sequence of parameters can be changed. Change the sequence of parameters in the header (first) row and then describe the information per this sequence in subsequent rows.
- The supported character encoding is SHIFT-JIS.
- CSV files up to 50 MB can be imported.
- If using a CSV file to only delete accounts, only the login_id and delete_flag parameters need to be described.
[ Note ]
Users imported from upstream user stores cannot be updated by importing CSV data. If such users are included in CSV files, the CSV import process will result in error, and no users, including the users not synchronized with external user stores, will be imported.
Users will not be imported if a successfully uploaded CSV file contains description errors. View the job status to confirm if the import process completed successfully. Refer to "Viewing Jobs" for more information on confirming jobs.
Example CSV File Description
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 |
Description Example (
represents line breaks)