WebAccount を作成するCreate webAccount

名前空間: microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph のバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported. API が v2.0 で利用できるかどうかを確認するには、 バージョン セレクターを使用します。To determine whether an API is available in v1.0, use the Version selector.

ユーザーのプロファイルに新しいwebAccountオブジェクトを作成します。Create a new webAccount object in a user's profile.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) ユーザー読み取り/書き込みユーザー。User.ReadWrite, User.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) ユーザー読み取り/書き込みユーザー。User.ReadWrite, User.ReadWrite.All
アプリケーションApplication User.ReadWrite.AllUser.ReadWrite.All

HTTP 要求HTTP request

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

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/json. Required.application/json. Required.

要求本文Request body

要求本文で、 webAccount オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of webAccount object.

次の表に、ユーザーのプロファイルに新しいwebAccountオブジェクトを作成するときに設定できるプロパティを示します。The following table shows the properties that are possible to set when you create a new webAccount object in a user's profile.

プロパティProperty Type 説明Description
allowedAudiences ユーザーallowedAudiences StringString エンティティ内に含まれている値を参照できる対象ユーザー。The audiences that are able to see the values contained within the entity. Itemfacetから継承されます。Inherited from itemFacet. 可能な値は、mefamilycontactsgroupMembersorganizationfederatedOrganizationseveryoneunknownFutureValue です。Possible values are: me, family, contacts, groupMembers, organization, federatedOrganizations, everyone, unknownFutureValue.
descriptiondescription StringString 参照されているサービスのアカウントに対してユーザーが指定した説明が含まれます。Contains the description the user has provided for the account on the service being referenced.
推測inference inferenceDatainferenceData エンティティが、アプリケーションの作成または変更によって推論された場合の推論の詳細が含まれます。Contains inference detail if the entity is inferred by the creating or modifying application. Itemfacetから継承されます。Inherited from itemFacet.
サービスservice serviceInformationserviceInformation 関連付けられているサービスに関する基本情報が含まれています。Contains basic detail about the service that is being associated.
sourcesource 個人データソースpersonDataSource 値は、別のサービスから同期された場合に発生します。Where the values originated if synced from another service. Itemfacetから継承されます。Inherited from itemFacet.
statusMessagestatusMessage StringString 指定または同期した場合に、クラウドサービスからの状態メッセージを格納します。Contains a status message from the cloud service if provided or synchronized.
userIduserId StringString Webaccount に対して表示されるユーザー名。The user name displayed for the webaccount.
webUrlwebUrl StringString クラウドサービスのユーザープロファイルへのリンクが含まれている場合は、そのプロファイルへのリンクが含まれています (存在する場合)。Contains a link to the user's profile on the cloud service if one exists.

応答Response

成功した場合、このメソッドは応答 201, Created コードと、応答本文で新しい webAccount オブジェクトを返します。If successful, this method returns 201, Created response code and a new webAccount object in the response body.

Examples

要求Request

要求の例を次に示します。The following is an example of the request.

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"
  }
}

応答Response

応答の例を次に示します。The following is an example of the response.

注: 読みやすくするために、ここに示す応答オブジェクトは短縮されている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

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"
}