List of published manuals

List of manuals for contractors

IIJ ID Service Manual [For Administrators]

Description of Groups CSV File

This section describes how to describe a CSV file used to import groups.

Items that can be described in the CSV file
CSV Header NameRequiredDescriptionDescriptionExample Entry
group_nameYesGroup name

Enter the name of the group.

A new group is created if the specified group name does not already exist. Group information is changed if the group name does exist.

Duplicate values cannot be specified in CSV files.

group-A
email
Group email address

Enter a group email address used for mailing list of the group.

group@example.jp
delete_flag

Deleting Groups

Deletes groups

Specify a value of "true" (delete) or "false" (do not delete).

Default: false

false
update_only_flag

Determines whether to allow user updates

Prevents group creation and deletion by importing CSV data.

Specify a value of "true" (allow) or "false" (do not allow).

Default: false

false
[ 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 groups, only the group_name and delete_flag parameters need to be described.

[ Note ]

  • Groups imported from upstream user stores cannot be updated by importing CSV data. If such groups are included in CSV files, the CSV import process will result in error, and no groups, including the groups not synchronized with external user stores, will be imported.
  • Groups 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

 Description Example (represents line breaks)

group_name,login_id,delete_flag
group_a,user01@example.jp,false
group_b,user02@example.jp,false
group_b,user03@example.jp,false
group_c,user04@example.jp,false
group_c,user05@example.jp,true