顧客のすべてのユーザー アカウントの一覧を取得する
この記事では、いずれかの顧客に属するすべてのユーザー アカウントの一覧を取得する方法について説明します。
ID で 1 つのユーザー アカウントを検索するには、「ID でユーザー アカウントを取得する」を参照してください。
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
顧客 ID です (
customer-tenant-id
)。 顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナー センターで検索できます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id
) と同じです。
GDAP ロール
次の GDAP ロールのうち少なくとも 1 つが必要です。
- ディレクトリ閲覧者
- グローバル閲覧者
- ユーザー管理者
C#
指定した顧客のすべてのユーザー アカウントのコレクションを取得するには:
指定した顧客 ID で IAggregatePartner.Customers.ById メソッドを呼び出して、顧客を識別します。
// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// Get customer users collection.
var customerUsers = partnerOperations.Customers.ById(selectedCustomerId).Users.Get();
例については、次を参照してください。
- サンプル: コンソール テスト アプリ
- プロジェクト: パートナー センター SDK のサンプル
- クラス: GetCustomerUserCollection.cs
REST 要求
要求の構文
認証方法 | 要求 URI |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/users HTTP/1.1 |
URI パラメーター
正しい顧客を識別するには、次の URI パラメーターを使用します。
名前 | 種類 | 必須 | 説明 |
---|---|---|---|
customer-tenant-id | guid | Y | この値は、リセラーがリセラーに 属する特定の顧客の結果をフィルター処理できるようにする、GUID 形式の customer-tenant-id です。 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
要求本文
[なし] :
要求の例
GET https://api.partnercenter.microsoft.com/v1/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 5d845377-5b7d-4cd4-98f6-19e5ae3faa81
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com
REST 応答
成功した場合、このメソッドは顧客のユーザー アカウントのコレクションを返します。
応答の成功とエラーのコード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。
応答の例
HTTP/1.1 200 OK
Content-Length: 1030
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 5d845377-5b7d-4cd4-98f6-19e5ae3faa81
MS-CV: 6zmKqrSFB0+t7m3y.0
MS-ServerId: 101112616
Date: Wed, 21 Dec 2016 21:13:24 GMT
{
"totalCount": 2,
"items": [{
"usageLocation": "US",
"id": "a9ef48bb-8758-4590-a312-d4a47bfaded4",
"userPrincipalName": "Daniel@dtdemocspcustomer005.onmicrosoft.com",
"firstName": "Daniel",
"lastName": "Tsai",
"displayName": "Daniel Tsai",
"userDomainType": "none",
"state": "active",
"links": {
"self": {
"uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users/a9ef48bb-8758-4590-a312-d4a47bfaded4",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerUser"
}
}, {
"id": "6e668259-1f09-479d-bcb8-d9b03e826b8d",
"userPrincipalName": "admin@dtdemocspcustomer005.onmicrosoft.com",
"firstName": "Daniel",
"lastName": "Tsai",
"displayName": "DT Demo CSP Customer 005",
"userDomainType": "none",
"state": "active",
"links": {
"self": {
"uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users/6e668259-1f09-479d-bcb8-d9b03e826b8d",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerUser"
}
}
],
"links": {
"self": {
"uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}