OneRoster プロバイダーの概要

OneRoster API (アプリケーション プログラミング インターフェイス) は、学生情報システム (SIS) /学生管理システム (SMS) データの交換のために、1EdTech (旧称 IMS Global) からの業界標準の形式です。 この同期方法を使用すると、SIS/SMS プロバイダーによって開発された REST ベースの OneRoster 1.1 API を使用して、SIS/SMS に直接接続できます。 API サポートを使用すると、CSV (コンマ区切り値) ファイルを使用する代わりに、データを直接同期できます。

OneRoster API を使用してデータを取り込むため、プロビジョニング用のコア SDS 機能を明るくすることができます。 また、Microsoft 365 の製品と機能のエクスペリエンスを強化することもできます。 OneRoster API は、School Data Sync (SDS) プラットフォームを介して OneRoster API を提供する SIS/SMS からオブジェクトを同期する方法です。

OneRoster API をソースとして使用するようにテナントを設定する方法の詳細については、「 OneRoster API を使用したデータ インジェスト」を参照してください。

OneRoster プロバイダーの状態と機能

[プロバイダー] がドロップダウンに表示されず、状態が [ テスト] と表示されます。 プロバイダーの一覧に表示するには、何を行う必要がありますか?

• カスタマー サポート チームに連絡してテナントをフライトし、現在テスト中の API プロバイダーにアクセスします。 要求を発生させるときに、次の情報を共有します。

  • テナント ID
  • OneRoster プロバイダー名
  • SDS バージョン
  • 名簿

• テナントがフライトされたら、OneRoster プロバイダーと SDS POC と連携してテストを実行し、統合が成功したことを確認します。 問題が発生した場合は、プロバイダーと SDS POC を使用して解決してください。

• テストが成功すると、OneRoster プロバイダーの状態が (テスト モードからはいに) 更新され、すべてのテナントでパブリックにアクセス可能なプロバイダーの一覧で使用できるようになります。

プロバイダーが一覧に表示されません。 SDS で OneRoster プロバイダーとして参加するために共有する情報はありますか?

• 次の記事「 SDS を使用した OneRoster API プロバイダーのオンボード ガイダンス」をプロバイダーと共有します。 この記事には、OneRoster プロバイダーとして追加することを要求するために必要な手順が含まれています。最初にテスト モードになる前にテストと検証を行い、最終的にはテナント別に選択するためにパブリック リストに配置されます。

名簿データを取り込むときにアクセスされているエンドポイントは何ですか?

• 次の一覧は、OneRoster API を使用して SIS/SMS に接続するときにアクセスされるデータを理解するのに役立ちます。

SDS に必要な API エンドポイント

SDS 用の省略可能な API エンドポイント

省略可能なユーザー学生の連絡先関係

保護者と保護者とのコミュニケーションのための教師エクスペリエンスを強化するために、学生ユーザーに学生の接触関係を指定できます。 連絡先は、/users と共に提供されるより多くのユーザーであり、学生への関連付けは、学生のユーザー レコードの [エージェント] の下にあります。

• 詳細については、SDS でサポートされている学生の連絡先関係の役割に関するページを 参照してください。既定の値の一覧: 連絡先のリレーションシップ ロールに関するページを参照してください。

• familyName、givenName、および電子メールは、連絡先/保護者ロールを持つユーザーに必要です。

• 電話とSMSがE.164にあり、+ が含まれている必要があります。 (例: +1234567890)

• 連絡先関係の保護者レコードから連絡先ユーザーの [エージェント] フィールドの学生に逆データが指定されている場合、これらのレコードは除外されます。

省略可能なユーザー人口統計フラグ

学生ユーザーがプログラムまたはコーホートに参加することを示すために、ユーザー フラグを指定できます。 ユーザー フラグが含まれる (ユーザーに対して true の場合)、または該当しない場合は含まれません。

フラグは、ユーザーのメタデータ拡張機能として、メタデータ フィールドで Key| に従って指定されます。値のペア。 キーの名前は microsoft.userFlags で、コンマ区切りリストとして書式設定する必要があります。 ユーザー フラグは任意の順序で表示され、大文字と小文字は区別されません。

詳細については、SDS でサポートされているユーザー フラグ値の既定の一覧については、「 既定の値の一覧: ユーザー フラグ」を参照してください。

例:

{ 
  "user" : { 
   … 
   … 
    "metadata" : { 
     "microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“ 
    } 
}

OneRoster API アクセス資格情報が必要

SIS/SMS の OneRoster API への接続を有効にするには、接続資格情報を指定する必要があります。 詳細については、特定のプロバイダーのドキュメントを参照して取得または生成します。

• Web アクセス URL: SIS/SMS で OneRoster API にアクセスできる URL

• SIS/SMS OneRoster API への接続に使用されるクライアント ID

• SIS/SMS OneRoster API への接続に使用されるクライアント シークレット

• アクセス トークン URL。SIS/SMS OneRoster API が OAuth2 を使用した認証用に構成されている場合は、接続に使用するアクセス トークン URL エンドポイントを指定する必要があります。 エンドポイントは Web アクセス URL とは異なります。

役に立つメモとヒント

• エンドポイントは常に 'https://{server_URL}/ims/oneroster/v1p1' の後に存在します

• エンドポイントには、状態によるフィルター処理を許可したり、差分同期を有効にしたりするためのフィルター パラメーターのサポートに関する要件があります。

• SDS は、差分同期/増分同期処理の dateLastModified プロパティにフィルターを適用し、SDS との統合に必要です。

• プロバイダーは、OAuth1(a) または OAuth 2.0 (クライアント資格情報付与) 認証スキームを実装する必要があります。 OAuth 2.0 が推奨されます。

• サポートされている認証プロトコルが "OAuth 2.0" である場合 - クライアント資格情報の許可の種類は、SDS によって "Authorization" ヘッダーに資格情報が送信されます。 OneRoster 仕様で推奨されているように、エンコードされたクライアント資格情報をトークン要求の Authorization ヘッダーに送信します。

OneRoster プロバイダーの詳細

Aequitas

Aeries

Arbor Education

Blackbaud Education Management

Bubblecon

ClassLink

Classter

Edge Learning

コミュニティ ブランドによる教育

Edulife Connect

eSchoolData

eSchooling

エウムスクールSIS

Eventful

事実

Focus School Software

Follett Aspen

INACAP SDS API

Infinitas Learning

Infinite Campus

inLogic

iSAMS by IRIS

IST

LIBRUS

MySchool

Rediker Software

SIMS

Skool

Skyward

SmartSchool

Synergy SIS

Trivium

Vigilo

Visma InSchool

VULCAN UONET+