メインコンテンツへスキップ

Microsoft Entra ID - SCIM API

Tom Noonan
  • 更新

このドキュメントでは、Microsoft の Entra ID ID 管理システムを構成して、SCIM と呼ばれる業界標準プロトコル (System for クロスドメイン ID 管理)。
Workvivoは、一連のSCIM 2.0互換による自動ユーザープロビジョニングをサポートしています
RESTful JSON API。このドキュメントでは、EntraIDを次のように設定する方法を学習します
これらのAPIを使用してWorkvivoにユーザーをプロビジョニングします。


大事な！
- Meta Workplaceの移行を実施する場合は、ユーザーの移行が完了するまでユーザーをプロビジョニングしないでください。

 

1. EntraIDにWorkvivoをエンタープライズアプリケーションとして追加する

Entra ADでWorkvivoを設定するための最初のステップは、Entra IDポータルを使用してWorkvivoをエンタープライズアプリケーションとして設定することです。

Microsoft Entra ID - シングル サインオンの記事を確認し、手順 1 に従って Workvivo をエンタープライズ アプリケーションとして追加します。


シングルサインオンの目的でEntraIDのアプリケーションとしてWorkvivoをすでに設定している場合は、この手順をスキップして、EntraIDの既存のWorkvivoアプリケーションに直接移動できます。

 

2. プロビジョニングテナントURLとシークレットトークンの設定

Entra IDインスタンスで作成したWorkvivo Enterpriseアプリケーションに移動します。

左側の「管理」サブナビゲーションリストの下にある「プロビジョニング」をクリックして、プロビジョニング設定画面に移動します。

 

 

デフォルトでは、「プロビジョニングモード」は「手動」に設定されています。このフィールドを「自動」に変更すると、一連の新しいフィールドが画面に表示されます。最初のステップは、Workvivo SCIMAPIの管理者クレデンシャルを入力することです。

 

 

[テナントURL]の下に、次のように入力します。

 

https://[YourWorkVivoDomain]/azure/v2/scim

 

ここで、「yourworkvivodomain」はWorkvivoインスタンスのドメイン名です。 https://[会社名].workvivo[.com][.us][.me]

*注 - WorkvivoインスタンスがEU、米国、またはUAEのデータセンターでホストされているかどうかに応じて、正しいドメインを入力していることを確認してください。どちらか workvivo.com になりますが、workvivo.us、または workvivo.me。また、組織がWorkvivoのカスタムドメイン名を設定している場合も、形式が異なる場合があります。Workvivoのドメイン名がわからない場合は、support@workvivo.com のサポートチームにお問い合わせください。「保存」ボタンを押して続行します。

 

「シークレットトークン」の下で [管理パネル]>[プロビジョニング設定]で直接トークンを生成してください（現在の管理者ユーザーが追加できる IT管理者 ロールが必要になります)。

スクリーンショット 2025-06-25 (11.37.46)AM.png
[SCIM Provider] ドロップダウンで [Other] を選択します。 このトークンは回復できないため、紛失した場合は新しいトークンを生成してEntra IDで設定する必要があります。

 

生成されたら、トークンをEntra IDに追加できます。「接続のテスト」ボタンを押すと、EntraIDは成功メッセージで応答します。次に、画面上部の[保存]ボタンを押します-もう一度、EntraIDは成功メッセージで応答するはずです。

 

 

3. 「Microsoft Entra ID グループのプロビジョニング」の無効化

この時点で、次に示すように、[マッピング] セクションの下に 2 つのレコードが表示されます。

大多数のお客様は、Workvivoに必要な関連チームデータをユーザーリソースから直接取得できるため、Entra IDグループを同期する必要はありません。そのため、[Microsoft Entra ID グループのプロビジョニング] をクリックして、Entra ID グループのマッピングを編集します。

 

開いた画面で、[有効] の下の [いいえ] をクリックして Entra ID グループのプロビジョニングを無効にし、画面上部の [保存] ボタンをクリックします。「はい」をクリックして変更を確定します。

 

これが完了したら、ウィンドウ右上の「X」をクリックしてAttribute Mapping画面を閉じ、前の画面に戻ります。[マッピング] セクションの [Entra ID グループ] の [有効] 列の下に [いいえ] と表示されます。

 

 

3. Entra IDユーザーマッピングの設定

最後のステップは、Entra IDユーザーのマッピングを確認することです。「Microsoft Entra ID グループのプロビジョニング」をクリックして、Entra ID ユーザーの属性マッピング画面を開きます。[属性マッピング] で、マッピングされている Entra ID 属性が組織にとって正しいものであることを確認します。ほとんどの場合、デフォルトのオプションが機能するはずです。

 

Workvivo で使用される "Customappsso" 属性とその使用方法を次に示します。

  • externalId (英語)
    SCIM プロビジョニングでは、Workvivo でユーザーを追加または更新するタイミングを決定するための一意の識別子として使用されます。デフォルトでは、これは mailNickname に設定されていますが、ユーザーが一意の mailNickname を持っていない場合は、ここでの source 属性をより一意の値 (objectID や userPrincipalName など) に変更することをお勧めします
  • ユーザー名*
    これをWorkvivoのメールにマッピングします。デフォルトでは、これはEntra IDで「userPrincipalName」に設定されています–この属性の値が組織のメールアドレスでない場合は、ここで別の属性を使用する必要があります(例:「メール」)

  • emails[type eq "work"].value*
    これをWorkvivoのメールにマッピングします。デフォルトでは、これはEntra IDの「userPrincipalName」に設定されています - この属性の値が組織のメールアドレスでない場合は、ここで別の属性(例:「mail」)を使用する必要があります。

    *非常に重要な userName と emails[type eq "work"].value は同じ値にマッピングされます
  • 名前.givenName
    ユーザーの名
  • 名前.ファミリー名
    ユーザーの姓
  • タイトル
    ユーザーの役職
  • phoneNumbers[type eq "mobile"].value
    ユーザーの携帯電話番号。これはWorkvivoのオプションのフィールドです
  • phoneNumbers[type eq "work"].value
    ユーザーの直通ダイヤル番号。これはWorkvivoのオプションのフィールドです
  • 能動
    ユーザーのアカウントをアクティブにするかどうか
  • 部
    ユーザーの部署。これはWorkvivoでチームとして設定され、まだ存在しない場合は作成され、ユーザーは自動的に割り当てられます。これは、Workvivo Adv Analyticsのプライマリチームにマッピングされます
  • addresses[type eq "work"].locality(英語)
    ユーザーの場所 (デフォルトは Entra ID の "city")。これはWorkvivoでチームとして設定され、まだ存在しない場合は作成され、ユーザーは自動的に割り当てられます。これは、Workvivo Adv Analyticsのセカンダリチームにマッピングされます
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter - これはデフォルトのマッピングではないため、追加の属性として追加する必要があります。これは、Workvivo Adv AnalyticsのTertiary Teamにマッピングされます

 

Workvivo の IT 担当者に、希望するプライマリ、セカンダリ、ターシャリ チームをお知らせください。これにより、Workvivo 側で設定できるようになります。

繰り返しになりますが、ほとんどの組織ではデフォルトのマッピングを変更する必要はありませんが、特定のWorkvivoフィールド(例:「都市」以外の場所には別の属性を使用します。

マッピングに満足したら、" X " ボタンをクリックしてウィンドウを閉じる。

 

 

4. 追加属性

追加の属性をマッピングする場合は、次の構文に従ってください。

[属性マッピング] – [詳細オプションの表示] - customappsso の属性リストの編集を選択します。

 

ここから、属性リストを編集できる。

 

採用日: 

urn: IETF: パラメーター:SCIM: スキーマ:エクステンション:Workvivo: 2.0: ユーザー:入社日 — 値は YYYY-MM-DD にする必要がある

 

生年月日:

urn: IETF: パラメーター:SCIM: スキーマ:エクステンション:Workvivo: 2.0: ユーザー:生年月日 — 値は YYYY-MM-DD にする必要がある

 

コストセンター:

まず、Workvivo ITの連絡先に、コストセンターの三次チームタイプ(Office、Tenant、Countryなど)の名前を伝える必要があります

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter

 

カスタムチームタイプ: 

まず、Workvivo ITの連絡先に追加のチームタイプ(Office、Tenant、Country)の名前を伝える必要があります

urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:wvtax_TeamTypeName 例: urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:wvtax_Office(英語)

 

カスタムフィールド:

まず、Workvivo ITの連絡先に追加フィールドの名前(代名詞、従業員番号など)を伝える必要があります

urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:CustomFieldName 例urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:代名詞

 

認証ロール:

ユーザーロールをプロビジョニングする場合は、次の構文を使ってください。

urn:ietf:params:scim:schemas:extension:workvivo:2.0:User:authRoles

値: admin、スペース モデレーター

 

 

5. Provisioning 同期の開始

これで、プロビジョニングのセットアップが完了しました。最初にテストする場合は、オンデマンドで数人のユーザーをプロビジョニングして、正しくアクセスしていることを確認してください。これを実行する前に、ユーザーをユーザー/グループに追加する必要があります。

成功した場合は、概要セクションで [プロビジョニングの開始] をクリックできます

 

 

初期同期には、スコープ内のユーザー数に応じて最大 1 時間かかる場合があります。

Entra ID は通常、20 分から 40 分ごとにデータをプロビジョニングしますが、これは Entra ID インスタンスのユーザー数によって異なる場合があります。

 

この時点で、EntraIDでプロビジョニングプロセスを開始したことをWorkvivoの連絡先に通知できます。関連する内部ログをチェックして、プロセスが期待どおりに機能していることを確認できます。プロビジョニングプロセスが 機能し始めたら、Entra ID でプロビジョニングログを確認できます。

プロビジョニングに問題がある場合は、ログにこれらのエラーに関する情報が表示されます。 残念ながら、これらはあまり役に立ちませんので、エラーが発生した場合は、プロビジョニングの問題を診断するのに役立つより有用なログが私たちの側で実施されているため、Workvivoに連絡して支援を求めてください。

関連記事