KDDI Business ID ユーザ 一括登録ツールマニュアル

KDDI Business ID
ユーザ 一括登録ツールマニュアル
2015.04.15版
KDDI株式会社
【目次】
1. 概要&導入
1-1.本ツールの概要
1-2.動作環境
1-3.ダウンロード方法
1-4.インストール方法
1-5.社内IPアドレス設定(必須)
2. ADからKBIへのデータ連携
2-1.連携可能項目と入力条件
2-2.連携手順
3. ADからCSVへのデータ出力
3-1.出力可能項目と入力条件
3-2.出力手順
4. CSVからKBIへのデータ入力
4-1.入力可能項目と入力条件
4-2.入力手順
5. その他
5-1.実行設定の保存
5-2.ツールの自動実行
5-3.ログイン条件プロファイルIDの確認
5-4.処理ログ
5-5.問い合わせ
1 / 12
1. 概要&導入
1-1.本ツールの概要
「KDDI Business ID」(以下KBI)へのユーザ一括登録を補助するツールです。
Active Directory(以下AD)との連携や、CSVファイルによる一括登録・変更が可能です。
※ユーザの一括削除には対応しておりません。
※KBI未契約のお客さまはご利用いただけません。
※KDDI Business IDにてSSO連携対象サービスが存在する場合、ユーザとサービスの紐づけも自動で行われます。
【データ入出力パターン】
パターンA:AD⇒KBI(手順については2章参照)
パターンB:AD⇒CSV(手順については3章参照)
パターンC:CSV⇒KBI(手順については4章参照)
【ご利用の流れ】
①ADからKBIへ直接ユーザ情報をコピーしたい場合
パターンAを実施してください。
②ADからKBIへユーザ情報をコピーする際に、一部情報を編集したい場合
パターンBを実施し、出力されたCSVファイルを編集後、パターンCを実施してください。
③ADを利用せず一括登録したい場合
ご自身でCSVファイルを作成し、パターンCを実施してください。
1-2.動作環境
お客さま社内環境
Active Directory
KDDIサーバ
ツール実行PC
SSL
サーバ
KDDI Business ID
【Active Directoryサーバ】
・Windows Server 2008以降であること(推奨)
【ツール実行PC】
・Windows Server 2008以降/Windows 7以降であること(推奨)
・Micorsoft .NET Framework 2.0 がインストールされていること
・Micorsoft .NET Framework 2.0 日本語 Language Pack がインストールされていること
・インターネットに対して下記のプロトコル/ポートが解放されていること
443(HTTPS) … SSOのAPIコール用
587 …完了通知メール用
・Active Directoryに対して下記のプロトコル/ポートが解放されていること
NetBIOS 名前サービス 137(tcp/udp)
NetBIOS データグラム サービス 138(tcp/udp)
NetBIOS セッション サービス 139(tcp/udp)
SMB 445(tcp/udp)
LDAP 389(tcp/udp)
LDAPS 636(tcp/udp)
LDAP グローバル カタログ 3268(tcp/udp)
Kerberos 88(tcp/udp)
DNS 53(tcp/udp)
1-3.ダウンロード方法
①KDDI ビジネスオンラインサポートにログイン後、メニューバーの右部にあるダウンロードボタンをクリックしてください。
ダウンロード
2 / 12
ダウンロード
②一括登録ツールの「ダウンロード」をクリックしてください。zipファイルがダウンロードされます。
1-4.インストール方法
本ツールにインストーラはありません。ツール実行PCにてzipファイル解凍後、任意のフォルダに格納してください。
フォルダ内の「KBISyncTool.exe」というファイルを実行すると、ツールが起動します。
1-5.社内IPアドレス設定(必須)
本ツールは、KBIのセキュリティ設定メニューにて社内IPアドレスを登録し、そのIPアドレスから実行する必要があります。
KDDI ビジネスオンラインサポートにログイン後、[セキュリティ]-[IPアドレス設定]にて下記の通り設定してください。
下記A/Bのどちらかを設定
A: ツール実行PCからインターネットアクセスする際のグローバルIPアドレス
(改行による複数指定、CIDR形式によるレンジ指定が可能)
B: 「0.0.0.0/0」
(この場合、すべての接続が社内扱いとなります)
3 / 12
4 / 12
2. ADからKBIへのデータ連携
2-1.連携可能項目と入力条件
ADからKBIへ連携できるデータと入力条件については以下のとおりです。
Active Directoryの項目
必須 入力制限
KDDI Business IDの項目
ユーザのプロパティ[全般]タブ-「姓」
○ 全角文字10文字以内
ユーザのプロパティ[全般]タブ-「名」
○ 全角文字10文字以内
ユーザのプロパティ[全般]タブ-「電話番号」
半角数字、半角ハイフン 1~15 文字
ユーザのプロパティ[全般]タブ-「電子メール」 ※1
○
半角英数字、記号3~127 文字
(メールアドレス形式)
ユーザのプロパティ[フリガナ]タブ-「姓」
※2 全角カナ20文字以内
ユーザのプロパティ[フリガナ]タブ-「名」
※2 全角カナ20文字以内
ユーザのプロパティ[所属されている組織]タブ-「部署」
半角英数、全角文字50文字以内
⇒ ユーザの「姓」
⇒ ユーザの「名」
⇒ ユーザの「電話番号」
ユーザの「ユーザID」、「メールアドレス」、「通知先メール
⇒ アドレス」
各契約中サービスのID※3
⇒ ユーザの「姓(カナ)」
⇒ ユーザの「名(カナ)」
⇒ ユーザの「所属」
※1:「電子メール」をキーに情報の登録/変更を行います。ADの「電子メール」の値にてKBIの「ユーザID」を検索し、存在しない場合はKBIへユーザを新規登録します。
すでに存在する場合は、当該KBIユーザに対して情報変更を行います。
※2:必須ではありませんが、ADにて入力なしの場合、KBIにて"ー"が設定されます。
※3:お客さまにて契約中のKBI連携サービス(Google Apps/Office 365ほか)のユーザIDとして登録し、サービス側のユーザへの紐づけが行われます。
Google Apps/Office 365については、サービスサーバ側へのユーザ登録も行います(事前にKBIにて認証情報/特権管理者設定が必要です)。
2-2.連携手順
②
①
③
①データ取得元タブ[ActiveDirectory]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ取得元にする」
○
ON(チェックを入れる)
ドメインFQDN
○
"0"を設定 ※FQDNの設定は現状機能しません
ADパス
○
参照するActive Directoryのパスを入力
AD管理者ID
○
Active Directoryにおける管理者アカウントのIDを入力
ADパスワード
○
Active Directoryにおける管理者アカウントのパスワードを入力
チェックボックス「ユーザ」
○
ON(チェックを入れる)
フィルタG
取得するActive Directoryユーザを「グループ」でフィルタリングしたい場合指定
プルダウン「フィルタ」
取得するActive Directoryユーザを各種情報でフィルタリングしたい場合指定
値
「フィルタ」で指定した項目のフィルタリングに用いる値を指定
②データ取得先タブ[KDDI Business ID]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ反映先にする」
○
ON(チェックを入れる)
管理者ID
○
KDDI Business IDの管理者IDを入力
パスワード
○
KDDI Business IDの管理者パスワードを入力
タイムアウトミリ秒
○
60000(デフォルト値、変更不要)
プロキシサーバを経由する場合:URL
インターネット接続にてProxyサーバを経由する場合、ProxyサーバのURLを指定
プロキシサーバを経由する場合:Port
チェックボックス「ユーザ」
インターネット接続にてProxyサーバを経由する場合、ProxyサーバのPort番号を指定
○
ON(チェックを入れる)
③[実行]をクリック
5 / 12
3. ADからCSVへのデータ出力
3-1.出力可能項目と入力条件
ADからCSVへ出力できるデータと入力条件については以下のとおりです。
Active Directoryの項目
必須 入力制限
ユーザのプロパティ[全般]タブ-「姓」
○ -
ユーザのプロパティ[全般]タブ-「名」
○ -
ユーザのプロパティ[全般]タブ-「電話番号」
CSVの項目
⇒ lastName
⇒ firstName
⇒ tel
-
uid,email,notificationEmail,
ユーザのプロパティ[全般]タブ-「電子メール」
⇒ googleapps.account,office365.account,
○ -
kcw.account,kks.account
ユーザのプロパティ[フリガナ]タブ-「姓」
-
ユーザのプロパティ[フリガナ]タブ-「名」
-
ユーザのプロパティ[所属されている組織]タブ-「部署」
-
⇒ lastNameKana
⇒ firstNameKana
⇒ department
3-2.出力手順
②
①
③
①データ取得元タブ[ActiveDirectory]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ取得元にする」
○
ON(チェックを入れる)
ドメインFQDN
○
"0"を設定 ※FQDNの設定は現状機能しません
ADパス
○
参照するActive Directoryのパスを入力
AD管理者ID
○
Active Directoryにおける管理者アカウントのIDを入力
ADパスワード
○
Active Directoryにおける管理者アカウントのパスワードを入力
チェックボックス「ユーザ」
○
ON(チェックを入れる)
フィルタG
取得するActive Directoryユーザを「グループ」でフィルタリングしたい場合指定
プルダウン「フィルタ」
取得するActive Directoryユーザを各種情報でフィルタリングしたい場合指定
値
「フィルタ」で指定した項目のフィルタリングに用いる値を指定
②データ取得先タブ[CSVファイル]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ反映先にする」
○
ON(チェックを入れる)
出力フォルダ
○
CSVを出力するフォルダのパスを指定
チェックボックス「ユーザCSV」
○
ON(チェックを入れる)
ファイル名
○
出力するCSVのファイル名を指定
エンコード
○
SJIS もしくは UTF8 を指定
③[実行]をクリック
6 / 12
4. CSVからKBIへのデータ入力
4-1.入力可能項目と入力条件
CSVからKBIへ入力できるデータと入力条件については以下のとおりです。
CSVの項目(カラム順、左から)
必須
入力制限
KDDI Business IDの項目
1 uid ※1
○
半角英数字、記号3~127 文字
(メールアドレス形式)
2 lastName
○
全角文字10文字以内
3 firstName
○
全角文字10文字以内
4 lastNameKana
※2
全角カナ20文字以内
5 firstNameKana
※2
全角カナ20文字以内
6 department
半角英数、全角文字50文字以内
⇒ ユーザの「ユーザID」
⇒
⇒
⇒
⇒
⇒
⇒
ユーザの「姓」
ユーザの「名」
ユーザの「姓(カナ)」
ユーザの「名(カナ)」
ユーザの「所属」
7 tel
※3
半角数字、半角ハイフン 1~15 文字
8 role
※4
1:ユーザ権限
99:管理者権限
⇒ ユーザの「権限」
ログイン条件プロファイルID ※8
⇒ ユーザの「ログイン条件」
0:有効
2:一時停止
69:パスワードロック
⇒ ユーザの「ステータス」
9 securityProfile
10 status
※5
11 telForAuth
半角数字11 文字、090/080/070で始まる値
12 email
○
13 notificationEmail
○
14 googleapps.account
15 office365.account
半角英数字、記号3~127 文字
(メールアドレス形式)
16 kcw.account
17 kks.account
⇒
⇒
⇒
⇒
⇒
⇒
⇒
ユーザの「電話番号」
ユーザの「着信認証用電話番号」
ユーザの「メールアドレス」
ユーザの「通知先メールアドレス」
ユーザのGoogle Apps 「アカウント」※6
ユーザのOffice 365 「アカウント」※6
ユーザの「KDDI ChatWorkログインメールアドレス」※7
ユーザの「Knowledge Suite ログインメールアドレス」※7
※1:uidをキーに情報の登録/変更を行います。uidの値にてKBIの「ユーザID」を検索し、存在しない場合はKBIへユーザを新規登録します。すでに存在する場合は、
当該KBIユーザに対して情報変更を行います。
※2:必須ではありませんが、CSVにて入力なしの場合、KBIにて"ー"が設定されます。
※3:roleが「管理者」の場合のみ必須
※4:入力なしの場合、ユーザとなります。
※5:変更時のみ指定が可能です。ユーザの新規登録時は指定内容にかかわらずステータス「未設定」となります。
※6:サービスを契約しKBI利用可能な状態の場合指定できます。Google Apps/Office 365については、サービスサーバ側へのユーザ登録も行われます(事前にKBI
にて認証情報/特権管理者設定が必要です)。Office 365の場合、365側の権限は「ユーザー」となります。
※7:KBIにてサービスのSSO設定を有効にしている場合指定できます。サービスサーバ側へのユーザ登録は行われません。
※8:KBIにて設定したログイン条件のプロファイルIDを指定します。指定なしの場合、デフォルトが適用されます。プロファイルIDの確認方法は、5-3をご確認ください。
4-2.入力手順
①テキストエディタ・表計算ソフトなどを利用してCSVファイルを作成/編集する。
・1行目はタイトル(ラベル)行です。順序は上記4-1.の表のとおりです。
・2行目以降に、タイトル(ラベル)に対応するユーザ情報を入力します。
・3章にて出力したCSVを編集し利用することも可能です。
・テキストエディタで編集する場合、文字コードはS-JISかUTF-8で保存してください。
・保存する際のファイル名は任意でOKです。
例:
1行目
2行目
以降
uid,lastName,firstName,lastNameKana,firstNameKana,department,tel,role,securityProfile,status,telForAuth,email
,notificationEmail,googleapps.account,office365.account,kcw.account,kks.account
[email protected],井出,太郎,イデ,タロウ,部署1,00000000000,99,,,,[email protected],[email protected],,,,
[email protected],井出,二郎,イデ,ジロウ,部署1,00000000001,99,,,,[email protected],[email protected],,,,
7 / 12
③
②
④
②データ取得先タブ[CSVファイル]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ取得元にする」
○
ON(チェックを入れる)
SETフォルダ
○
①で作成したCSVファイルを配置したフォルダのパスを指定
ACTIVEフォルダ
ー
使用しません
SUCCESSフォルダ
ー
使用しません
FAILEDフォルダ
ー
使用しません
SETファイル拡張子
ー
使用しません
チェックボックス「ユーザCSV」
○
ON(チェックを入れる)
ファイル名
○
①で作成したCSVのファイル名を指定
エンコード
○
SJIS もしくは UTF8 を指定
③データ取得先タブ[KDDI Business ID]を選択し、下記の内容を入力
項目
必須
設定内容
チェックボックス「データ反映先にする」
○
ON(チェックを入れる)
管理者ID
○
KDDI Business IDの管理者IDを入力
パスワード
○
KDDI Business IDの管理者パスワードを入力
タイムアウトミリ秒
○
60000(デフォルト値、変更不要)
プロキシサーバを経由する場合:URL
インターネット接続にてProxyサーバを経由する場合、ProxyサーバのURLを指定
プロキシサーバを経由する場合:Port
チェックボックス「ユーザ」
インターネット接続にてProxyサーバを経由する場合、ProxyサーバのPort番号を指定
○
ON(チェックを入れる)
④[実行]をクリック
8 / 12
5. その他
5-1.実行設定の保存
ツール上で入力した設定は、保存し次回起動時に再利用することが可能です。
①ツールの左上にある「実行設定ファイル」欄に設定保存したいファイル(拡張子.xml)のパス(ファイル名込み)を指定します。
xxxx.xml
②ツールの右下にある「実行設定保存」ボタンをクリックすると設定が保存されます。
次回ツールを起動した際に、実行設定ファイルに保存した設定が復元されます。
5-2.ツールの自動実行
本ツールを自動実行する場合は、Windowsのタスクスケジューラを使用します。
【事前準備】
「2. ADからKBIへのデータ連携」の手順をツールで1度実施し、その後上記5-1.の手順を実施してください。
①ツール実行PCにて、下記ページを参考にタスクスケジューラを起動します。
https://technet.microsoft.com/ja-jp/library/cc721931.aspx
②[操作]-[基本タスクの作成]をクリックします。
③基本タスクの作成ウィザードにて、タスクの「名前」「説明」を入力(内容は任意)し、[次へ]をクリックします。
9 / 12
④タスクを開始するトリガーを指定し、[次へ]をクリックします。
⑤トリガーの詳細条件を指定し、[次へ]をクリックします。(画面は毎月の場合です)
⑥[次へ]をクリックします。
10 / 12
⑦以下のとおり入力し、[次へ]をクリックします。
ツールの展開フォルダ内の
bat/sync_ADtoKBI.bat
のフルパス
ツールの展開フォルダ内の
batフォルダのフルパス
⑧[完了]をクリックします。
5-3.ログイン条件プロファイルIDの確認
CSVで指定するログイン条件プロファイルID(securityProfile)の確認方法についてご説明します。
KDDI ビジネスオンラインサポートにログイン後、[セキュリティ]-[ログイン条件]を開きます。
対象のログイン条件名称下部
に表示されている値をcsvにて
指定してください。
11 / 12
5-4.処理ログ
ツールの実行結果は処理ログに出力されます。
ログは「処理ログ」タブにて確認できるほか、ツールと同フォルダに生成される「log」フォルダ内に1日毎にファイル記録・保存されます。
5-5.問い合わせ
本ツールについて不明点があった場合は、弊社担当営業までご連絡ください。
12 / 12