連絡先を一覧表示する
名前空間: microsoft.graph
サインイン中のユーザーの既定の連絡先フォルダーから連絡先コレクションを取得します。
アプリが別のユーザーの連絡先フォルダーから連絡先を取得できるシナリオは2つあります。
- アプリにアプリケーションのアクセス許可がある場合。または
- アプリに「あるユーザーから適切に委任されたアクセス許可」があり、別のユーザーがそのユーザーとコンタクトフォルダーを共有しているか、そのユーザーに委任されたアクセスを付与している場合。 詳細と例を参照してください。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | Contacts.Read | Contacts.ReadWrite |
| 委任 (個人用 Microsoft アカウント) | Contacts.Read | Contacts.ReadWrite |
| アプリケーション | Contacts.Read | Contacts.ReadWrite |
HTTP 要求
ユーザーの既定の連絡先フォルダー内のすべての連絡先を取得する
GET /me/contacts
GET /users/{id | userPrincipalName}/contacts
ユーザーのメールボックス内の特定のフォルダーにある連絡先を取得する
GET /me/contactfolders/{Id}/contacts
GET /users/{id | userPrincipalName}/contactfolders/{id}/contacts
GET /me/contactFolders/{id}/childFolders/{id}/.../contacts
GET /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts
オプションのクエリ パラメーター
たとえば、$filter クエリ パラメーターを使って、メール アドレスに基づいて連絡先をフィルターすることができます。
GET https://graph.microsoft.com/v1.0/me/contacts?$filter=emailAddresses/any(a:a/address eq 'garth@contoso.com')
、、および 演算子はeq、emailAddresses コレクション内のインスタンスのアドレス サブプロパティでのみ使用$filteranyできます。 つまり、emailAddresses のインスタンスの名前やその他のサブプロパティをフィルター処理することも、 などのnelestartswith()他の演算子や関数をfilter適用することもできません。
$filterクエリのパラメーターの一般的な情報については、OData クエリ パラメーターを参照してください。
要求ヘッダー
| ヘッダー | 値 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の 連絡先 オブジェクトのコレクションを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/me/contacts
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"parentFolderId": "parentFolderId-value",
"birthday": "datetime-value",
"fileAs": "fileAs-value",
"displayName": "displayName-value",
"givenName": "givenName-value",
"initials": "initials-value"
}
]
}