チュートリアル: Documo を構成し、自動ユーザー プロビジョニングに対応させる
このチュートリアルでは、自動ユーザー プロビジョニングを構成するために Documo と Microsoft Entra ID の両方で行う必要がある手順について説明します。 構成すると、Microsoft Entra ID で、Microsoft Entra プロビジョニング サービスを利用して、Documo に対するユーザーおよびグループのプロビジョニングおよびプロビジョニング解除が自動的に行われます。 このサービスが実行する内容、しくみ、よく寄せられる質問の重要な詳細については、「Microsoft Entra ID による SaaS アプリへのユーザー プロビジョニングとプロビジョニング解除の自動化」を参照してください。
サポートされる機能
- Documo でユーザーを作成する
- アクセスが不要になった場合に Documo のユーザーを削除する
- Microsoft Entra ID と Documo の間でユーザー属性の同期を維持する
- Documo に対してシングル サインオンを行う (推奨)。
前提条件
このチュートリアルで説明するシナリオでは、次の前提条件目があることを前提としています。
- Microsoft Entra テナント
- アプリケーション管理者ロール、クラウド アプリケーション管理者ロール、またはアプリケーション所有者ロールのいずれか。
- API アクセスを備えた Documo アカウント。
- Documo の管理者権限を持つユーザー アカウント。
手順 1:プロビジョニングのデプロイを計画する
- プロビジョニング サービスのしくみを確認します。
- プロビジョニングの対象となるユーザーを決定します。
- Microsoft Entra ID と Documo の間でマップするデータを決定します。
手順 2: Microsoft Entra ID でのプロビジョニングをサポートするように Documo を構成する
- Microsoft Entra のプロビジョニングに使う API キーを生成します。
- ご自分の API URL を見つけて覚えておいてください。 既定の API URL は
https://api.documo.com
です。 カスタム Documo API ドメインがある場合は、Documo のブランド設定ページの [ドメイン] タブで参照できます。
手順 3: Microsoft Entra アプリケーション ギャラリーから Documo を追加する
Microsoft Entra アプリケーション ギャラリーから Documo を追加して、Documo へのプロビジョニングの管理を開始します。 SSO のために Documo を以前に設定している場合は、同じアプリケーションを使用できます。 ただし、統合を初めてテストするときは、別のアプリを作成することをお勧めします。 ギャラリーからアプリケーションを追加する方法の詳細については、こちらを参照してください。
手順 4:プロビジョニングの対象となるユーザーを定義する
Microsoft Entra プロビジョニング サービスを使うと、アプリケーションへの割り当てや、ユーザーやグループの属性に基づいて、プロビジョニングされるユーザーのスコープを設定できます。 割り当てに基づいてアプリにプロビジョニングされるユーザーのスコープを設定する場合、以下の手順を使用して、ユーザーとグループをアプリケーションに割り当てることができます。 ユーザーまたはグループの属性のみに基づいてプロビジョニングされるユーザーのスコープを設定する場合、こちらで説明されているスコープ フィルターを使用できます。
小さいところから始めましょう。 全員にロールアウトする前に、少数のユーザーとグループでテストします。 プロビジョニングのスコープが割り当て済みユーザーとグループに設定される場合、これを制御するには、1 つまたは 2 つのユーザーまたはグループをアプリに割り当てます。 スコープがすべてのユーザーとグループに設定されている場合は、属性ベースのスコープ フィルターを指定できます。
追加のロールが必要な場合は、アプリケーション マニフェストを更新して新しいロールを追加できます。
手順 5:Documo への自動ユーザー プロビジョニングを構成する
このセクションでは、Microsoft Entra ID でのユーザー割り当てやグループ割り当てに基づいて、Documo でユーザーが作成、更新、無効化されるように Microsoft Entra プロビジョニング サービスを構成する手順について説明します。
Microsoft Entra ID で Documo の自動ユーザー プロビジョニングを構成するには、次の手順を実行します。
クラウド アプリケーション管理者以上として Microsoft Entra 管理センターにサインインします。
[ID]>[アプリケーション]>[エンタープライズ アプリケーション] の順に移動します
アプリケーションの一覧で [Documo] を選択します。
[プロビジョニング] タブを選択します。
[プロビジョニング モード] を [自動] に設定します。
[管理者資格情報] セクションで、Documo の [テナントの URL] と [シークレット トークン] を入力します。
[テナントの URL] は、手順 2 で末尾に
/scim/v2
を追加して準備した API URL です。 カスタム ドメインのないユーザーの値はhttps://api.documo.com/scim/v2
である必要があります。[シークレット トークン] フィールドに、手順 2 で準備した API キーをコピーして貼り付けます。 [接続テスト] をクリックして、Microsoft Entra ID で Documo に接続できることを確認します。 接続できない場合は、使用中の Documo アカウントに管理者アクセス許可があることを確認してから、もう一度試します。
[通知用メール] フィールドに、プロビジョニングのエラー通知を受け取るユーザーまたはグループの電子メール アドレスを入力して、 [エラーが発生したときにメール通知を送信します] チェック ボックスをオンにします。
[保存] を選択します。
[マッピング] セクションで、[Microsoft Entra ユーザーを Documo に同期する] を選択します。
[属性マッピング] セクションで、Microsoft Entra ID から Documo に同期されるユーザー属性を確認します。 [照合] プロパティとして選択されている属性は、更新処理で Documo のユーザー アカウントとの照合に使用されます。 一致する対象の属性を変更する場合は、その属性に基づいたユーザーのフィルター処理が Documo API でサポートされることを確認する必要があります。 [保存] ボタンをクリックして変更をコミットします。
属性 Type フィルター処理のサポート userName String ✓ active Boolean name.givenName String name.familyName String roles[primary eq "True"].value String スコープ フィルターを構成するには、スコープ フィルターのチュートリアルの次の手順を参照してください。
Documo に対して Microsoft Entra プロビジョニング サービスを有効にするには、[設定] セクションで [プロビジョニング状態] を [オン] に変更します。
[設定] セクションの [スコープ] で目的の値を選び、Documo にプロビジョニングするユーザーやグループを定義します。
プロビジョニングの準備ができたら、 [保存] をクリックします。
この操作により、 [設定] セクションの [スコープ] で定義したすべてのユーザーとグループの初期同期サイクルが開始されます。 初期サイクルは後続の同期よりも実行に時間がかかります。後続のサイクルは、Microsoft Entra のプロビジョニング サービスが実行されている限り約 40 分ごとに実行されます。
手順 6:デプロイを監視する
プロビジョニングを構成したら、次のリソースを使用してデプロイを監視します。
- プロビジョニング ログを使用して、正常にプロビジョニングされたユーザーと失敗したユーザーを特定します。
- 進行状況バーを確認して、プロビジョニング サイクルの状態と完了までの時間を確認します。
- プロビジョニング構成が異常な状態になったと考えられる場合、アプリケーションは検疫されます。 検疫状態の詳細については、こちらを参照してください。