顧客の削除されたユーザーを表示する
顧客 ID で顧客の削除された CustomerUser リソースの一覧を取得します。 必要に応じて、ページ サイズを設定できます。 フィルターを指定する必要があります。
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
顧客 ID です (
customer-tenant-id)。 顧客の ID がわからない場合は、[顧客] ワークスペースを選択し、顧客の一覧から顧客を選択し、[アカウント] を選択して、パートナー センターで検索できます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
ユーザー アカウントを削除するとどうなりますか?
ユーザー アカウントを削除すると、ユーザーの状態は "非アクティブ" に設定されます。 30 日間メイン、その後、ユーザー アカウントとそれに関連付けられているデータが消去され、回復不能になります。 30 日以内に削除されたユーザー アカウントを復元する場合は、「顧客の削除されたユーザーを復元する」を参照してください。 削除されて "非アクティブ" とマークされると、ユーザー アカウントはユーザー コレクションのメンバーとして返されなくなります (たとえば、顧客のすべてのユーザー アカウントの一覧を取得するを使用)。 削除されていない削除されたユーザーの一覧を取得するには、非アクティブに設定されているユーザー アカウントを照会する必要があります。
C#
削除されたユーザーの一覧を取得するには、状態が非アクティブに設定されている顧客ユーザーをフィルター処理するクエリを作成します。 まず、次のコード スニペットに示すように、パラメーターを 使用して SimpleFieldFilter オブジェクトをインスタンス化してフィルターを作成します。 次に、BuildIndexedQuery メソッドを使用してクエリを作成します。 結果をページ分割したくない場合は、代わりに BuildSimpleQuery メソッドを使うことができます。 次に、顧客 ID と共に IAggregatePartner.Customers.ById メソッドを使用して、顧客を識別します。 最後に、Query メソッドを呼び出して要求を送信します。
// IAggregatePartner partnerOperations;
// int customerUserPageSize;
// Create a filter for users whose status is inactive (i.e. deleted).
var filter = new SimpleFieldFilter("UserState", FieldFilterOperation.Equals, "Inactive");
// Build a paged query.
var simpleQueryWithFilter = QueryFactory.Instance.BuildIndexedQuery(customerUserPageSize, 0, filter);
// Send the request.
var customerUsers = partnerOperations.Customers.ById(selectedCustomerId).Users.Query(simpleQueryWithFilter);
サンプル: コンソール テスト アプリ。 プロジェクト: パートナー センター SDK サンプル クラス: GetCustomerInactiveUsers.cs
REST 要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | {baseURL}/v1/customers/{customer-id}/users?size={size}>filter={filter} HTTP/1.1 |
URI パラメーター
要求を作成するときは、次のパスとクエリ パラメーターを使用します。
| 名前 | タイプ | Required | 説明 |
|---|---|---|---|
| customer-id | guid | はい | 値は、顧客を識別する GUID 形式の顧客 ID です。 |
| size | int | いいえ | 一度に表示される結果の数。 このパラメーターは省略可能です。 |
| フィルター | フィルター | はい | ユーザーの検索をフィルター処理するクエリ。 削除されたユーザーを取得するには、文字列 {"Field":"UserState","Value":"Inactive","Operator":"equals"} を含めてエンコードする必要があります。 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
要求本文
なし。
要求の例
GET https://api.partnercenter.microsoft.com/v1/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users?size=500&filter=%7B%22Field%22%3A%22UserState%22%2C%22Value%22%3A%22Inactive%22%2C%22Operator%22%3A%22equals%22%7D HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: c11feb95-55d2-45b6-9d1b-74b55d2221fb
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com
REST 応答
成功した場合、このメソッドは応答本文で CustomerUser リソースのコレクションを返します。
応答の成功とエラーのコード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。
応答の例
HTTP/1.1 200 OK
Content-Length: 802
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 1187f9ad-02b4-4d96-b668-7cf3d289467b
MS-CV: 3TLmR9gz6EaCVCjR.0
MS-ServerId: 101112616
Date: Fri, 20 Jan 2017 19:13:14 GMT
{
"totalCount": 1,
"items": [{
"usageLocation": "US",
"id": "a45f1416-3300-4f65-9e8d-f123b397a4ea",
"userPrincipalName": "e83763f7f2204ac384cfcd49f79f2749@dtdemocspcustomer005.onmicrosoft.com",
"firstName": "Ferdinand",
"lastName": "Filibuster",
"displayName": "Ferdinand",
"userDomainType": "none",
"state": "inactive",
"softDeletionTime": "2017-01-20T00:33:34Z",
"links": {
"self": {
"uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users/a45f1416-3300-4f65-9e8d-f123b397a4ea",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerUser"
}
}
],
"links": {
"self": {
"uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/users?size=500&filter=%7B%22Field%22%3A%22UserStatus%22%2C%22Value%22%3A%22Inactive%22%2C%22Operator%22%3A%22equals%22%7D",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}