次の方法で共有

oneRosterApiDataConnector を作成する

  • [アーティクル]

名前空間: microsoft.graph.industryData

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい oneRosterApiDataConnector オブジェクトを作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) IndustryData-DataConnector.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション IndustryData-DataConnector.ReadWrite.All 注意事項なし。

HTTP 要求

POST /external/industryData/dataConnectors

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 oneRosterApiDataConnector オブジェクトの JSON 表現を指定します。

次の表に、 oneRosterApiDataConnector オブジェクトを作成するために必要なプロパティと省略可能なプロパティを示します。

プロパティ 種類 説明
displayName String データ コネクタの名前。 industryDataConnector から継承されます。 必須。
apiFormat microsoft.graph.industryData.apiFormat 接続されている外部システムの API 形式。 apiDataConnector から継承されます。 使用可能な値は、 oneRoster、 unknownFutureValueです。 必須。
baseUrl String 後続の '/' の有無にかかわらず、スキーム、ホスト、パスを含むベース URI。 たとえば、"https://example.com/ims/oneRoster/v1p1"。 apiDataConnector から継承されます。 必須です。
資格 情報 microsoft.graph.industryData.credential サポートされているすべての資格情報の基本型。 apiDataConnector から継承されます。 必須。
apiVersion String OneRoster ソースの API バージョン。 必須です。
isDemographicsEnabled ブール型 ユーザーがオプションの人口統計データをインポートするように指定したかどうかを示します。 必須です。
isFlagsEnabled ブール型 ユーザーがオプションのフラグ データをインポートするように指定したかどうかを示します。 必須です。
isContactsEnabled ブール型 ユーザーがオプションの連絡先データをインポートするように指定したかどうかを示します。 必須です。

応答

成功した場合、このメソッドは応答コードと、応答本文で更新された microsoft.graph.industryData.oneRosterApiDataConnector オブジェクトを返201 Createdします。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/external/industryData/dataConnectors
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.oneRosterApiDataConnector",
  "displayName": "Generic OAuth2 Connector",
  "sourceSystem@odata.bind": "https://graph.microsoft.com/beta/external/industryData/sourceSystems('c93a6e02-aeb7-437f-cc52-08dc3fc158af')",
  "apiFormat": "oneRoster",
  "baseUrl": "https://fakeProvider.net/ims/oneroster/v1p1",
  "apiVersion": "1.1",
  "credential": {
    "@odata.type": "#microsoft.graph.industryData.oAuth2ClientCredential",
    "displayName": "One Roster API Credentials",
    "clientId": "530be723-6af3-4952-8658-668fb2598ad7",
    "clientSecret": "thisIsASecret",
    "tokenUrl": "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
    "scope": null
  },
  "isDemographicsEnabled": false,
  "isFlagsEnabled": false,
  "isContactsEnabled": false
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.industryData.oneRosterApiDataConnector",
  "id": "f72b2c92-4b8b-461d-3725-08dc3fc158ff",
  "displayName": "Generic OAuth2 Connector",
  "apiFormat": "oneRoster",
  "baseUrl": "https://fakeProvider.net/ims/oneroster/v1p1",
  "apiVersion": "1.1",
  "isDemographicsEnabled": false,
  "isFlagsEnabled": false,
  "isContactsEnabled": false,
  "credential": {
    "@odata.type": "#microsoft.graph.industryData.oAuth2ClientCredential",
    "displayName": "One Roster API Credentials",
    "isValid": true,
    "lastValidDateTime": null,
    "clientId": "530be723-6af3-4952-8658-668fb2598ad7",
    "tokenUrl": "https://login.microsoftonline.com/c27f982b-f7ee-4b8b-bb0e-3c55bd1dc02c/oauth2/token",
    "scope": null
  }
}