顧客の削除されたユーザーを表示するView deleted users for a customer

適用対象Applies To

  • パートナー センターPartner Center

顧客 ID によって顧客の削除されたユーザーリソースの一覧を取得します。Gets a list of deleted CustomerUser resources for a customer by customer ID. 必要に応じてページサイズを設定することもできます。You can optionally set a page size. フィルターを指定する必要があります。You must supply a filter.

前提条件Prerequisites

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。This scenario supports authentication with App+User credentials only.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

ユーザーアカウントを削除するとどうなりますか。What happens when you delete a user account?

ユーザーアカウントを削除すると、ユーザーの状態が "非アクティブ" に設定されます。The user state is set to "inactive" when you delete a user account. 30日間はそのままで、ユーザーアカウントとそれに関連付けられたデータが消去され、回復できなくなります。It remains that way for thirty days, after which the user account and its associated data are purged and made unrecoverable. 30日の期間内に削除されたユーザーアカウントを復元する場合は、「 顧客に対して削除されたユーザーを復元する」を参照してください。If you want to restore a deleted user account within the thirty day window, see Restore a deleted user for a customer. 削除され、"inactive" とマークされた場合、ユーザーアカウントはユーザーコレクションのメンバーとして返されなくなります (たとえば、[ 顧客のすべてのユーザーアカウントの一覧を取得する] を使用します)。Once deleted and marked "inactive", the user account is no longer returned as a member of the user collection (for example, using Get a list of all user accounts for a customer). 削除されていないユーザーの一覧を取得するには、非アクティブに設定されているユーザーアカウントを照会する必要があります。To get a list of deleted users that have not yet been purged, you must query for user accounts that have been set to inactive.

C#C#

削除されたユーザーの一覧を取得するには、状態が非アクティブに設定されている顧客のユーザーをフィルター処理するクエリを作成します。To retrieve a list of deleted users, construct a query that filters for customer users whose status is set to inactive. まず、次のコードスニペットに示すように、パラメーターを使用して Simplefieldfilter オブジェクトをインスタンス化することで、フィルターを作成します。First, create the filter by instantiating a SimpleFieldFilter object with the parameters as shown in the following code snippet. 次に、 Buildindexedquery メソッドを使用してクエリを作成します。Then create the query using the BuildIndexedQuery method. ページングされた結果が不要な場合は、代わりに Buildsimplequery メソッドを使用できます。If you do not want paged results, you can use the BuildSimpleQuery method instead. 次に、顧客 ID と共に ById メソッドを使用して顧客を識別します。Next, use the IAggregatePartner.Customers.ById method with the customer ID to identify the customer. 最後に、 クエリ メソッドを呼び出して要求を送信します。Finally, call the Query method to send the request.

// 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);

サンプル: コンソールテストアプリSample: Console test app. プロジェクト: パートナーセンター SDK サンプル クラス: GetCustomerInactiveUsers.csProject: Partner Center SDK Samples Class: GetCustomerInactiveUsers.cs

REST 要求REST request

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
GETGET {baseURL}/v1/customers/{customer-id}/users? size = {size} &フィルター = {FILTER} HTTP/1.1{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

URI パラメーターURI parameter

要求の作成時には、次のパスとクエリパラメーターを使用します。Use the following path and query parameters when creating the request.

名前Name 種類Type 必須Required 説明Description
customer-idcustomer-id guidguid はいYes 値は、顧客を識別する GUID 形式の顧客 id です。The value is a GUID formatted customer-id that identifies the customer.
sizesize INTint いいえNo 一度に表示される結果の数。The number of results to be displayed at one time. このパラメーターは省略できます。This parameter is optional.
filterfilter filterfilter はいYes ユーザーの検索をフィルター処理するクエリ。The query that filters the user search. 削除されたユーザーを取得するには、文字列 {"Field":"UserState","Value":"Inactive","Operator":"equals"} を含めてエンコードする必要があります。To retrieve deleted users, you must include and encode the following string: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

[なし] :None.

要求の例Request example

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: 2b4ab588-f48c-4874-b479-a61895e107b2
X-Locale: en-US
Host: api.partnercenter.microsoft.com

REST 応答REST response

成功した場合、このメソッドは、応答本文内の ユーザー リソースのコレクションを返します。If successful, this method returns a collection of CustomerUser resources in the response body.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information. このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, error type, and additional parameters. 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。For the full list, see Partner Center REST error codes.

応答の例Response example

HTTP/1.1 200 OK
Content-Length: 802
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 690b34ca-07c8-4f8a-ab13-f22a50594a43
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"
    }
}