ここでは、利用者情報管理コマンドで利用するCSVファイルの種別と書式について説明します。
CSVファイルの種別
利用者情報の各情報に対して、それぞれ1つのCSVファイルが対応します。以下に、利用者情報に対応するCSVファイルを示します。
利用者情報 | CSVファイル |
|---|---|
ユーザー | User.csv |
グループ | Group.csv |
ロール | Role.csv |
グループの所属ユーザー | Group-User.csv |
ロールの所属メンバー | Role-Member.csv |
CSVファイルの書式
CSVファイルの1行目はヘッダー行で、カラム名(フィールド属性名)を示します。CSVファイルの種別によって、有効なカラムが異なります。有効なカラム名については、exportの出力結果で確認することもできます。
注意
CSVファイルは、文字コードUTF-8で保存してください。
カラムに指定する値は、そのまま記述するか、ダブルクォーテーション(")で囲んで記述してください。
ただし、カンマを含む値の場合は、値全体をダブルクォーテーション(")で囲んで記述する必要があります。
例えば、User.csvのpurviewカラムに、systemとgroupをカンマ区切りで指定する場合は、以下のように記述します。
"system,group"
空文字列を指定する場合は、以下のどちらかの方法で記述してください。
カンマの間に値を1文字も記述しない
以下にidカラムに空文字を指定する例を示します。
"id","groupName","description","parentGroup.id" ,"group1","グループ1","34"
ダブルクォーテーション(")を2つ記述する
以下にidカラムに空文字を指定する例を示します。
"id","groupName","description","parentGroup.id" "","group1","グループ1","34"
シャープ(#)から始まる行はコメントとみなされ、その1行は無視されます。
以下に例を示します。
#"12","group1","グループ1","34"
以下に、各CSVファイルのカラムを示します。カラムの順番は任意です。
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
id | オブジェクトを特定するオブジェクトID
| 数値 | ○ |
userId | ユーザーID | <>"&*/:|?\,と半角空白とタブコードを除く半角英数字(ASCII文字) | ○ |
password | パスワード 認証種別がInteraction Manager認証の場合に、本カラムを指定せずにユーザーを作成した場合、そのユーザーでポータルにログインできません。ログインするためには、パスワードの設定が必要となります。 | ",と半角空白とタブコードを除く半角英数字(ASCII文字) | － |
userName | ユーザー名 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
userName_ja | 日本語のユーザー名 以下のオプションとimportを一緒に指定した場合、本カラムは指定できません。また、exportと一緒に指定した場合は、本カラムは出力されません。
| <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
userName_en | 英語のユーザー名 以下のオプションとimportを一緒に指定した場合、本カラムは指定できません。また、exportと一緒に指定した場合は、本カラムは出力されません。
| <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
userLevel | 利用者の区別 | 以下のどちらかの値 | － |
purview | 管理者の権限 | 以下の値(単数または複数指定可能) userLevelがuserの場合： userLevelがadminの場合： | － |
account_state | アカウントのロック状態 | 以下のどれかの値 | － |
ui_language | ユーザーの言語種別 (注7) ・ユーザー選択の場合 デフォルトで、「日本語」が設定されます。 ・固定の場合 固定の言語が設定されます。 | 以下のどちらかの値 また、V10.0.1までと同様、以下の指定も可能です。 ・ JAPANESE：日本語 export時は、以下の値が出力されます。 ・-v10.0.1を指定しない場合：jaまたはen ・-v10.0.1を指定した場合: JAPANESEまたはENGLISH | － |
拡張項目名 | 拡張項目の値 | 拡張項目の定義属性に従った値 (注4) | ○ |
○：必須、－：省略可能
注1) 新規登録時の必須カラムを示します。更新時は、userIdカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、userIdカラムだけが必須で、それ以外に指定されたカラムは無視されます。なお、-byidオプションまたは-v10.0.1オプション(-byuseridは指定せず)を指定した場合は、userIdカラムの代わりに、idカラムが必須カラムとなります。
注2) ユーザーのロック状態の「lockednow」は、ログイントライ可能回数による規制に該当したユーザーに対し、システムがロック状態を一時ロック状態へ変更します。あるユーザーの管理コンソールおよびポータルへのログインを禁止したい場合は、「locked」を選択してください。
注3) 管理コンソールで、ポリシーのユーザー情報として定義されている拡張項目の項目名です。利用者情報管理コマンドを利用して、新規に拡張項目を追加することはできません。
注4) 値の文字種と文字数については、「2.4.2 ポリシー」を参照してください。
注5) 拡張項目の定義が必須となっている場合は、カラムの指定も必須です。
注6) idカラムは-byidオプションまたは-v10.0.1オプション(-byuseridは指定せず)を指定した場合だけ利用できます。
注7) 本設定値は、言語ポリシーの言語の設定がユーザー選択の場合に、画面表示に利用する言語となります。言語ポリシーの言語の設定が固定言語となっている場合は、言語ポリシーの設定が優先されます。
記述例)
デフォルト動作時(-byidおよび-v10.0.1オプションを共に指定しない場合)
"userId","password","userName","userName_ja","userName_en","userLevel","purview","account_state","ui_language","email","phone"... "user1","password1","user001","ユーザー001","user001","admin","system,group","normal","ja","email01@example.com","0123456789"... "user2","password2","user002","ユーザー002","user002","user","user","locked","ENGLISH","email02@example.com","1234567890"...
-byidオプション指定時
"id","userId","password","userName","userName_ja","userName_en","userLevel","purview","account_state","ui_language","email","phone"... "57","user1","password1","user001","ユーザー001","user001","admin","system,group","normal","ja","email01@example.com","0123456789"... "132","user2","password2","user002","ユーザー002","user002","user","user","locked","ENGLISH","email02@example.com","1234567890"...
注意
管理コンソールで拡張項目の項目名として、User.csvのカラム名と同じ文字列を設定した場合、利用者情報管理コマンドでは以下のように処理されます。
exportの場合
利用者情報管理コマンドでは、上記の表の順番でカラムが出力されます。
以下に、「userLevel」という項目名の拡張項目が設定されている場合の出力例を示します。
"id","userId","password","userName","userName_ja","userName_en","userLevel","purview","account_state","ui_language","userLevel"
この例では、1つ目のuserLevelカラムが「利用者の区別」のカラムで、2つ目のuserLevelカラムが拡張項目に対応します。
importの場合
importで指定するUser.csvに同名のカラムが存在するかどうかで、以下のように処理が異なります。
同名のカラムが存在するとき
同名の2つのカラムのうち、1つ目のカラムがユーザーの基本的な項目とみなされ、2つ目のカラムが拡張項目とみなされます。
同名のカラムが存在しないとき
idやuserLevelなどのカラムは、同名の拡張項目が設定されていても、拡張項目のカラムとはみなされずに、ユーザーの基本的な項目のカラムとみなされます。
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
id | オブジェクトを特定するオブジェクトID
| 数値 | ○ |
groupId | グループID システムで一意です。
| <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
groupName | グループ名 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
description | グループの説明 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
parentGroupId | 親グループのグループID
| <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
parentGroup.id | 親グループのオブジェクトID
| 数値 | － |
○：必須、－：省略可能
注1) 新規登録時の必須カラムを示します。更新時は、groupIdカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、groupIdカラムだけが必須で、それ以外に指定されたカラムは無視されます。なお、-byidオプションまたは-v10.0.1オプションを指定した場合は、groupIdカラムの代わりに、idカラムが必須カラムとなります。
注2) idカラムは-byidオプションまたは-v10.0.1オプションを指定した場合だけ利用できます。
注3) groupIdカラムは-v10.0.1オプションを指定した場合は利用できません。
注4) parentGroup.groupIdカラムとparentGroup.idカラムは、-v10.0.1オプションの指定に従って、どちらかを指定します。作成時に、両方指定しない場合は、デフォルトで親グループは指定されません。
記述例)
デフォルト動作時(-byidおよび-v10.0.1オプションを共に指定しない場合)
"groupID","groupName","description","parentGroupId" "group1","group1","グループ1","" "group2","group2","グループ2","group1"
-byidオプション指定時
"id","groupID","groupName","description","parentGroupId" "12","group1","group1","グループ1","" "46","group2","group2","グループ2","group1"
ポイント
1つのGroup.csvファイルに、親グループの関係を記述する場合は、行の順番に注意してください。
親グループを指定する場合は、子グループの行の前に、親グループの行が作成されている必要があります。
以下に、group1とgroup2を作成し、group2の親グループをgroup1にする例で説明します。
正しい記述例
2行目でgroup1を作成し、3行目でgroup2の親グループとしてgroup1を指定します。2行目の処理で、グループgroup1が作成されるため、3行目の実行時にgroup1は存在し、group2の作成処理が成功します。
"groupId","groupName","description","parentGroupId" "group1","group1","グループ1","" "group2","group2","グループ2","group1"
誤った記述例
2行目でgroup2を作成する際に、親グループとして指定されたgroup1は存在しないため、group2の作成処理はエラーとなります。
"groupId","groupName","description","parentGroupId" "group2","group2","グループ2","group1" "group1","group1","グループ1",""
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
id | オブジェクトを特定するオブジェクトID
| 数値 | ○ |
roleId | ロールID
| <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
role_name | ロール名 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
role_name_ja | 日本語のロール名 以下のオプションとimportを一緒に指定した場合、本カラムは指定できません。また、exportと一緒に指定した場合は、本カラムは出力されません -v10.0.1 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
role_name_en | 英語のロール名 以下のオプションとimportを一緒に指定した場合、本カラムは指定できません。また、exportと一緒に指定した場合は、本カラムは出力されません -v10.0.1 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
role_description | ロールの説明 | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | － |
role_priority | ロールの優先度 | 数値(0～9999) | － |
publishRole | ロールの公開 | 以下のどちらかの値 | － |
○：必須、－：省略可能
注1) 新規登録時の必須カラムを示します。更新時は、roleIdカラムだけが必須で、それ以外に指定されたカラムの値が更新されます。削除時は、roleIdカラムだけが必須で、それ以外に指定されたカラムは無視されます。なお、-byidオプションまたは-v10.0.1オプションを指定した場合は、roleIdカラムの代わりに、idカラムが必須カラムとなります。
注2) idカラムは-byidオプションまたは-v10.0.1オプションを指定した場合だけ利用できます。
注3) roleIdカラムは-v10.0.1オプション指定した場合は利用できません。
記述例)
デフォルト動作時(-byidおよび-v10.0.1オプションを共に指定しない場合)
"roleId","role_name","role_name_ja","role_name_en","role_description","role_priority","publishRole" "role1","role1","ロール1","role1","description1","12","false" "role2","role2","ロール2","role2","description2","23","true" "role3","role3","ロール3","role3","description3","34","false"
-byidオプション指定時
"id","rolId","role_name","role_name_ja","role_name_en","role_description","role_priority","publishRole" "34","role1","role1,"ロール1","role1","description1","12","false" "45","role2","role2",ロール2","role2","description2","23","true" "78","role3","role3,"ロール3","role3","description3","34","false"
ポイント
グループの所属ユーザーを追加する場合は、追加する情報をGroup-User.csvファイルに記述し、importで指定します。
グループの所属ユーザーをグループから削除する場合は、削除する情報をGroup-User.csvファイルに記述し、deleteで指定します。
デフォルト動作時(-v10.0.1オプションを指定しない時)
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
groupId | 関連付けるグループのグループID | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
userId | グループに所属するユーザーのユーザーID | <>"&*/:|?\,と半角空白とタブコードを除く半角英数字(ASCII文字) | ○ |
○：必須
Example:
"groupId","userId" "SalesDiv","FujitsuTaro" "PersonelDiv","FujitsuHanako" "DevelopDiv1","FujitsuJiro"
ポイント
-byidオプションの有無で、動作は変わりません。
V10.0.1互換動作時（-v10.0.1オプション指定時）
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
Group.id | 関連付けるグループのオブジェクトID | 数値 | ○ |
User.id | グループに所属するユーザーのオブジェクトID | 数値 | ○ |
userId | グループに所属するユーザーのユーザーID | <>"&*/:|?\,と半角空白とタブコードを除く半角英数字(ASCII文字) | ○ |
○：必須
注) User.idカラムとuserIdカラムは、-byuseridオプションの指定に従って、どちらかを指定します。
記述例)
"Group.id","User.id" "12","57" "12","132" "46","132"
ポイント
ロールの所属グループを追加する場合は、追加する情報をRole-Member.csvファイルに記述し、importで指定します。
ロールの所属グループを解除する場合は、解除する情報をRole-Member.csvファイルに記述し、deleteで指定します。
デフォルト動作時(-v10.0.1オプションを指定しない時)
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
roleId | 関連付けるロールのロールID | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
Member.type | ロールに所属するメンバーの種別 | 「Group」固定 | ○ |
memberId | ロールに所属するグループのグループID | <>"&を除くすべての文字列(全角文字と半角文字は混在可能) | ○ |
○：必須
Example:
"roleId","Member.type"," memberId" "Sales","Group","SalesDiv" "Personel","Group","PersonelDiv" "Development","Group","DevelopDiv1"
ポイント
-byidオプションの有無で、動作は変わりません。
デフォルト動作時(-v10.0.1オプションを指定しない時)
カラム名 | 説明 | 指定可能な値 | 必須 |
|---|---|---|---|
Role.id | 関連付けるロールのオブジェクトID | 数値 | ○ |
Member.type | ロールに所属するメンバーの種別 | 「Group」固定 | ○ |
Member.id | ロールに所属するグループのオブジェクトID | 数値 | ○ |
○：必須
記述例)
"Role.id","Member.type","Member.id" "34","Group","12" "34","Group","46" "45","Group","132"
