File Format for User Information
This page describes the file format for adding or changing users.
For details on how to import a file, refer to the following page:
Adding or Changing Users and Departments Using a File
File Format
Enter the information of one user in each row.
Each row requires the following items. These items are mandatory and cannot be omitted.
- Login Name
- Display Name
- New Login Name
- Password
- Surname
- Given Name
- Phonetic Surname
- Phonetic Given Name
- Localized Name
- Language for Localized Name
- E-mail Address
- Status
- Language
- Time Zone
- Phone
- Extension
- Mobile Phone
- URL
- Employee ID
- Hire Date
- Birthday
- About Me
- Display Order
- Skype Name
- Delete
For details on the items above, refer to the following page:
Items of User Information
Items to be entered in a file
Enter an asterisk (*) for the items that you want to leave unchanged.
Login Name
To add a new user
Enter a string that does not duplicate existing users' login names.
To change the information of an existing user
Enter the existing login name.
When you want to change the existing login name, enter it in "Login Name". Enter a new login name in "New Login Name".
Display Name
"Display Name" must be a string.
New Login Name
To change "Login Name"
Enter a new login name.
To add a new user, or to change information other than "Login Name"
Enter a string that is identical to "Login Name", or enter "*".
Password
To add a new user
Enter a password.
If a user is added by entering "*", a valid password will not be set for them. The user needs to take one of the following actions to log in:
- Ask cybozu.cn Administrators to set a password.
- Log in with SAML authentication.
To change the password of an existing user
Enter a new password.
Localized Name
Other than the default "Display Name", you can enter a display name for each language.
Setting 'Localized Name'
Language for Localized Name
If you enter "Localized Name", this item is mandatory.
Enter one of the following for this item:
- Japanese: ja
- English: en
- Simplified Chinese: zh
- Traditional Chinese: zh-TW
- Spanish: es
Status
Enter one of the following for this item:
- To use cybozu.cn
Enter "1". - To deactivate a user
Enter "0".
Language
Enter one of the following for this item:
Leaving this field blank sets the language to "Use Web browser settings".
- Japanese: ja
- English: en
- Simplified Chinese: zh
- Traditional Chinese: zh-TW
- Spanish: es
- Use Web browser settings: auto
If the Web browser is configured to use a language other than Japanese, English, or Chinese, cybozu.cn will be displayed in English.
Time Zone
Refer to "List of Time Zones" to enter the ID of the time zone.
Leave this field blank to set the time zone to the system time zone.
Hire Date
Enter a string in either of the following formats: "YYYY-MM-DD" or "YYYY/MM/DD".
Birthday
Enter a string in either of the following formats: "YYYY-MM-DD" or "YYYY/MM/DD".
To Be Deleted
Enter one of the following for this item:
- To delete a user
Enter "1". - To add or update a user
Enter "*" or leave the item blank.
Trimming Whitespaces
If the following items contain a leading or trailing space, it will be trimmed when the data is imported from the file.
- Login Name
- New Login Name
- Surname
- Given Name
- Phonetic Surname
- Phonetic Given Name
- Localized Name
- Language of Localized Name
- E-mail Address
- Status
- Language
- Time Zone
- Phone
- Extension
- Mobile Phone
- URL
- Employee ID
- Hire Date
- Birthday
- Display Order
- Skype Name
- Delete
Example File
Example of actions to perform
- Add a user account whose login name is "kato".
- Deactivate the user account whose login name is "takahashi".
- Change the user information of "tanaka".
- Login Name
- Display Name
- Surname
- Phonetic Surname
- Localized Name
- Change the password of "sato".
- Delete the user account whose login name is "yamada".
Example of CSV file description
Login Name, Display Name, New Login Name, Password, Surname, Given Name, Phonetic Surname, Phonetic Given Name, Localized Name, Language for Localized Name, E-mail Address, Status, Language, Time Zone, Phone, Extension, Mobile Phone, URL, Employee ID, Hire Date, Birthday, About Me, Display Order, Skype Name, To Be Deleted
kato, Daisuke Kato, *, password, Kato, Daisuke, Kato, Daisuke, Daisuke Kato, en, kato@example.com, 1, ja, Asia/Tokyo, 000-0000-0000, #1234, , https://example.com, 0001, 2023-07-01,1980-01-01, , , daisuke-kato, *
takahashi,*, *, *, *, *, *, *, *, *, *, 0, *, Asia/Tokyo, *, *, *, *, *, *, *,*, *, *, *
tanaka, Manami Yamamoto, yamamoto, *, Yamamoto, Manami, Yamamoto, Manami, Manami Yamamoto, en, *, *, *, *, *, *, *, *, *, *, *, *, *, *, *
sato,*, *,newpassword, *, *, *, *, *, *, *, *, *, Asia/Tokyo, *, *, *, *, *, *, *,*, *, *, *
yamada,*, *, *, *, *, *, *, *, *, *, 0, *, Asia/Tokyo, *, *, *, *, *, *, *,*, *, *, 1
The first row contains "Field Name". Omit the first row containing the field names, or select "Skip header row" when importing a file.
Custom Fields
If any custom fields have been added to user information, you must also include such fields in the file to be imported.
Adding Fields in User Information (Custom Fields)
Example of CSV file descriptions including custom fields
The information for custom fields need to be appended to the "To Be Deleted" item.
If "Work Location" and "Seat No." have been added as custom fields, enter the items as follows:
Login Name, Display Name, New Login Name, Password, Surname, Given Name, Phonetic Surname, Phonetic Given Name, Localized Name, Language for Localized Name, E-mail Address, Status, Language, Time Zone, Phone, Extension, Mobile Phone, URL, Employee ID, Hire Date, Birthday, About Me, Display Order, Skype Name, To Be Deleted, Work Location, Seat No.
kato, Daisuke Kato, *, password, Kato, Daisuke, Kato, Daisuke, Daisuke Kato, en, kato@example.com, 1, ja, Asia/Tokyo, 000-0000-0000, #1234, , https://example.com, 0001, 2023-07-01,1980-01-01, , , daisuke-kato, *, Tokyo Head Office, 28F-B101
If You Receive a "Language for Localized Name Is Not Valid" Message
This section provides a solution when importing user information from a file displays the "Language for Localized Name is not valid" message.
Example of an Error Message
Error messages are displayed in "Import Results".
Cause and Solution
It is caused by one of the following reasons:
- You imported a file without selecting "Skip header row".
- When the entered text cannot be used for "Language for Localized Name".
Perform one of the following solutions respectively.
When you imported a file without selecting "Skip header row"
An error occurs when you import a file without selecting "Skip header row" even though the file has field names in the first row.
Select "Skip header row" when importing a file.
When the entered text cannot be used for "Language for Localized Name"
An error occurs when you enter a string that cannot be used for "Language for Localized Name".
Check Language for Localized Name and correct "Language for Localized Name" for the line that is written in the error message.
If you do not want to enter "Localized Name", leave the item blank.