Get contactFolderGet contactFolder

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

連絡先フォルダー ID を使用して連絡先フォルダーを取得します。Get a contact folder by using the contact folder ID.

アプリで別のユーザーの連絡先フォルダーを取得するには、次の2つのシナリオがあります。There are two scenarios where an app can get another user's contact folder:

  • アプリにアプリケーションのアクセス許可がある場合。またはIf the app has application permissions, or,
  • アプリに「あるユーザーから適切に委任されたアクセス許可」があり、別のユーザーがそのユーザーとコンタクトフォルダーを共有しているか、そのユーザーに委任されたアクセスを付与している場合。If the app has the appropriate delegated permissions from one user, and another user has shared a contact folder with that user, or, has given delegated access to that user. 詳細と例を参照してください。See details and an example.

アクセス許可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) Contacts.Read、Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Contacts.Read、Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
アプリケーションApplication Contacts.Read、Contacts.ReadWriteContacts.Read, Contacts.ReadWrite

HTTP 要求HTTP request

GET /me/contactFolders/{id}
GET /users/{id | userPrincipalName}/contactFolders/{id}

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

要求ヘッダーRequest headers

名前Name Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

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

Example

要求Request

以下は、要求の例です。Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/contactFolders/{id}
応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 104

{
  "displayName": "Finance",
  "id": "AAMkAGI2TKI5AAA=",
  "parentFolderId": "AAMkAGI2AAEOAAA="
}