こんにちは、ネクストモードの鮎澤です。
OktaではCSVファイルをインポートすることで簡単に新規ユーザーを作成したり、既存ユーザーの情報を更新したりすることができます。CSVファイルを自前で用意する必要はなく、Okta側でテンプレートが用意されているので、そちらをダウンロードしてユーザーに必要な属性を入力するだけでインポートできます。
本ブログでは、基本的なCSVインポートのやり方から、ユーザープロファイルに属性を追加した場合のインポート方法、インポート時に躓いた点の回避方法などをまとめてみましたので、これからCSVファイルでのインポートを検討されている方の参考になれば幸いです。
アジェンダは以下のとおりです。
はじめに、何かしらの方法でOkta側にユーザーを追加してアクティブ化すると、原則として対象ユーザーにアクティベーションメールが届きます（送信されないケースもあるため、詳細は後述の表をご参照ください）。アクティベーションメールを含むOktaから送信されるメールの言語は、ユーザーが表示言語を明示的に選択していない場合に次の順で決まるのですが、この章では②の設定方法をご紹介します。
①ユーザーの locale プロパティの値（設定されている場合）
②組織の表示言語設定
変更方法は簡単です。まずはOkta Admin Console（以下、管理者コンソール）にログインし、カスタマイズ＞ブランドをクリックして、下図の矢印先のブランド名をクリックします。
設定タブから表示言語の設定で、言語を日本語に設定するとアクティベーションメール含め、ブランドの優先言語が日本語になります。
①の方法を軽くご紹介すると、Okta上の各ユーザーのプロファイル - 属性にlocaleがあり、ここに「ISO 639-1の2文字の言語コード + _（アンダースコア） + ISO 3166-1の2文字の国コード」を連結したものを入力することで、Oktaから送信されるメールの言語を調整することができます。
例えばlocaleを「en_US」にすると、①が優先されるので②で日本語を設定しても、Oktaから送信されるメールの言語は英語になります。
運用方針によりますが、Oktaから送信されるメールの言語が日本語で問題なく、かつユーザーのlocaleを指定する必要が無い場合は②で日本語に切り替える方が楽だと考えています。
逆に、様々な国籍の方が在籍している企業であれば、localeを設定すると良いと思います。
お待たせいたしました。CSVファイルのインポート方法をご紹介します。まずはCSVファイルのテンプレートをダウンロードするため、管理者コンソールにログインし、ディレクトリ＞ユーザーをクリックします。ユーザー一覧の画面が表示されるので、その他アクションから『CSVからユーザーをインポート』を選択するとCSVインポート画面が表示されます。この画面の青文字で書かれている『このテンプレート』をクリックすると、CSVファイルがダウンロードされるので、このファイルを編集してインポートしていきます。
CSVファイルをExcelやスプレッドシートで開くと下図のように、1行目にユーザープロファイルの属性が英語で書かれており、2行目以降に必要な情報を入力していく流れとなります。
ユーザー追加に必要な情報を入力できましたら、再度管理者コンソールにログインし、テンプレートをダウンロードしたときと同じ操作でCSVインポート画面を開きます。
下図のように『参照』をクリックして入力したCSVファイルを選択します。
そして必ず『CSVをアップロード』をクリックしてください。CSVをアップロードで『次へ』が押せるようになります。正常にアップロードできたら『次へ』クリックします。
これから追加するユーザーをアクティブユーザー数に含めたくないので、『新しいユーザーを自動的にアクティブ化』のチェックを外して、『ユーザーをインポート』をクリックしてユーザーをインポートします。
エラーなどがなければ、数秒でユーザーが追加されます。
先ほどのCSVインポートで『新しいユーザーを自動的にアクティブ化』のチェックを外してインポートしましたが、チェックを入れた場合はユーザーのステータスが『ユーザーアクション保留中』となり、Oktaからアクティベーションメールが送信されます。
チェックの有無による挙動の違いを簡単に表でまとめてみましたので、ご参考にしてください。
なお『パスワードを作成せず、IDプロバイダー経由でのみログインを許可する』は、『新しいユーザーを自動的にアクティブ化』を有効にしないと選択できない仕様になっているため、組み合わせは以下の3パターンのみとなります。
| 新しいユーザーを 自動的にアクティブ化 |
パスワードを作成せず、 IDプロバイダー経由でのみ ログインを許可する |
ユーザーステータス | アクティベーション メールの送信 |
ユースケース |
|---|---|---|---|---|
| チェックなし | 選択不可 | 段階的 | 無し※1 | ・アクティブユーザー数に含めず、一時的にインポートしたいとき ・入社前にあらかじめユーザーを作成したいとき ・検証で利用したいとき |
| チェックあり | チェックなし | ユーザーアクション保留中 | 有り | ・追加したユーザーをすぐにOktaから利用できるようにしたいとき |
| チェックあり | チェックあり | アクティブ | 無し | ・外部IDプロバイダーを介して認証するユーザーにのみ使用する場合 |
※1 インポート時はアクティベーションメールは送信されませんが、ユーザー一覧から手動でアクティブ化した後に送信されます。
アクティブ化後のパスワード設定について補足します。
『段階的』『ユーザーアクション保留中』のいずれの場合も、アクティブ化後にユーザー自身でパスワードを設定する必要があります。ただし、OktaとADを連携しADの委任認証を有効化している場合はパスワード設定は不要です。また『パスワードを作成せず、IDプロバイダー経由でのみログインを許可する』を選択した場合は、外部IDプロバイダーを介して認証するためパスワード設定は発生しません。
テンプレートのCSVファイルを開くと約30個の属性が確認でき、すべて入力するのは大変だと思います。これらの属性をすべて埋める必要があるのか、という問いについては「すべて埋める必要はない」が回答になります。また、ユーザーを追加する際に不要な属性の列を削除しても、Okta側で正しく読み取ってインポートしてくれるので、必要な属性のみに絞ったCSVファイルを作成するのもおすすめです。
とはいえ、入力必須の属性があるので、以下属性は必ず埋めてください。
例えば必須入力の属性とdepartmentのみ残して他は削除した状態で、それぞれ入力してインポートしてみます。
エラーもなく無事にインポートでき、ユーザーが作成されました。見切れていますが、emailやdepartmentも問題なくインポートできています。
属性関連でもう一つご紹介したいことがあります。例えば部署を兼務しているユーザーがいるとします。その場合、下図のようにディレクトリ＞Profile Editorの『ユーザー（デフォルト）』から、「department02」のように属性を追加することができるのですが、追加後にCSVファイルのテンプレートをダウンロードすると、この追加した属性が反映されたテンプレートを利用することができます。
または、先ほどご紹介した不要な属性を削除したCSVファイルの1行目に「department02」の列を追加すれば問題なくインポートできます。
下図のようにCSVファイルに入力した「department02」の情報が反映されていることを確認できました。
CSVファイルをインポートした際に文字化けするケースがあります。そのときはCSVファイルの文字コードを確認してみてください。
文字コードがANSI（Shift-JIS）の状態でインポートすると文字化けすることを確認しているので、文字コードをUTF-8形式に変更してファイルを保存し、再度インポートすると文字化けが解消されますので、ぜひ試してみてください。
CSVインポートでユーザーを追加する際の基本的な操作と、インポート時の疑問や躓きポイントについて、アンサーする形でご紹介しました。CSVファイルから不要な属性を削除しても、Oktaが柔軟にファイルの内容を正しく解析してくれるため、普段の運用でもかなりありがたいポイントだと考えています。
今回ご紹介したTipsやトラブルシュートがお役に立ちましたら幸いです。
ネクストモードでは、Okta の導入から運用までを包括的に支援しています。Okta の導入・活用をご検討の際は、ぜひお問い合わせください。