查看客户的已删除用户

项目
03/06/2024

按客户 ID 获取已删除的 CustomerUser 资源的列表。可以选择设置页面大小。必须提供筛选器。

先决条件

合作伙伴中心身份验证中所述的凭据。此方案只支持使用应用凭据和用户凭据进行身份验证。
客户 ID (customer-tenant-id)。如果不知道客户的 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 参数

创建请求时，请使用以下路径和查询参数。

名称	类型	必需	说明
customer-id	guid	是	该值是标识客户的 GUID 格式的客户 ID。
size	int	否	一次要显示的结果数。此参数是可选的。
filter	筛选器	是	对用户搜索进行筛选的查询。若要检索已删除用户，必须包括并编码以下字符串：{"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: 2b4ab588-f48c-4874-b479-a61895e107b2
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: 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"
    }
}