File Format for Groups or Roles

Article Number:020147
Intended audience: Kintone Users & System Administrators

This page describes the file format for adding or changing groups (or roles).

For details on how to import a file, refer to the following page:
Adding or Changing Users and Departments Using a File

File Format

Only groups entered in the file are added or changed.
When the "Group Code" you entered in the file is identical to the existing code of the group in kintone.com, the group information will be overwritten.

Enter the information of one group (or role) in each row.
Each row requires the following items. These items are mandatory and cannot be omitted.

  • Group Code
  • Name
  • New Group Code
  • Membership Type
  • Description
  • Delete

For details on the items above, refer to the following page:
Items of Group Information

Items to be entered in a file

Enter an asterisk (*) for the items that you want to leave unchanged.

Group Code

To add a new group

Enter a string that that does not duplicate existing group codes.

To change the information of existing groups

Enter the existing group code.
When you want to change the existing group code, enter a new group code in "New Group Code".

Name

"Name" must be a string.
Enter a string that does not duplicate existing group names.

New Group Code

To change "Group Code"

Enter a new group code.

To add a new group, or to change information other than "Group Code"

Enter a string that is identical to "Group Code", or enter "*".

Membership Type

To add a new group

Enter one of the following for this item:

  • Static group: "static"
  • Dynamic group: "dynamic"

As for the difference in membership types, refer to the following page:
Membership Type

To change the information of existing groups

Enter either a membership type of an existing group or "*".
You cannot change the existing membership type, for example from static to dynamic.

To Be Deleted

Enter one of the following for this item:

  • To delete a group
    Enter "1".
  • To add a group, or to change group information
    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.

  • Group Code
  • Name
  • New Group Code
  • Membership Type
  • Delete

Example of CSV File Descriptions

The first row can be used for the field names. You can omit the first row, or select "Skip header row" when importing a file.
Enter an asterisk (*) for items you do not want to add or update.

To add groups

The following is an example of how to add the static group "grp001" and the dynamic group "grp002".

The content has been copied.
Group Code, Name, New Group Code, Membership Type, Description, To Be Deleted
grp001, Managers, *, static, *, *
grp002, Part-timers, *, dynamic, *, *

To change group information

The following is an example of how to change the group information of "grp003".
Change the following items.

  • Name
  • Group Code
  • Description
The content has been copied.
Group Code, Name, New Group Code, Membership Type, Description, To Be Deleted
grp003, Group3(Obsolete), old-group3, *, This group was obsoleted., *

To delete a group

The following is an example of how to delete "grp004".
For "To Be Deleted", enter "1".

The content has been copied.
Group Code, Name, New Group Code, Membership Type, Description, To Be Deleted
grp004, *, *, *, *, 1