webAccount の作成

名前空間: microsoft.graph

重要

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

ユーザーのプロファイルに新しい webAccount オブジェクトを作成します。

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

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

アクセス許可

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

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

HTTP 要求

POST /me/profile/webAccounts
POST /users/{id | userPrincipalName}/profile/webAccounts

要求ヘッダー

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

要求本文

リクエストの本文には、 webAccount オブジェクトの JSON 表現を指定します。

次の表は、ユーザーのプロファイルに新しい webAccount オブジェクトを作成するときに設定できるプロパティを示しています。

プロパティ 型 説明
allowedAudiences 文字列 エンティティに含まれる値を表示できる対象ユーザー。 itemFacet から継承されます。 指定できる値は、 me、 family、 contacts、 groupMembers、 organization、 federatedOrganizations、 everyone、 unknownFutureValue です。
説明 String 参照されているサービスのアカウントに対してユーザーが指定した説明が含まれます。
推論 inferenceData エンティティが作成または変更するアプリケーションによって推論される場合の推論の詳細が含まれます。 itemFacet から継承されます。
サービス serviceInformation 関連付けられているサービスに関する基本的な詳細が含まれています。
source personDataSource 別のサービスから同期された場合の値の発信元。 itemFacet から継承されます。
statusMessage 文字列 クラウド サービスが提供または同期されている場合に、クラウド サービスからのステータス メッセージを含みます。
userId String webaccount に表示されるユーザー名。
webUrl String クラウド サービス上のユーザーのプロファイルが存在する場合は、そのプロファイルへのリンクが含まれます。

応答

成功した場合、このメソッド 201, Created 応答コードと、応答本文の新しい webAccount オブジェクトを返します。

例

要求

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

POST https://graph.microsoft.com/beta/me/profile/webAccounts
Content-type: application/json

{
  "description": "My Github contributions!",
  "userId": "innocenty.popov",
  "service": {
    "name": "GitHub",
    "webUrl": "https://github.com"
  }
}

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "source": null,
  "description": "My Github contributions!",
  "userId": "innocenty.popov",
  "service": {
    "name": "GitHub",
    "webUrl": "https://github.com"
  },
  "statusMessage": null,
  "webUrl": "https://github.com/innocenty.popov"
}