Wyświetlanie użytkowników usuniętych dla klienta

Artykuł
09/11/2024

Pobiera listę usuniętych zasobów CustomerUser dla klienta według identyfikatora klienta. Opcjonalnie można ustawić rozmiar strony. Należy podać filtr.

Wymagania wstępne

Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie tylko przy użyciu poświadczeń aplikacji i użytkownika.
Identyfikator klienta (customer-tenant-id). Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim, wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id).

Co się stanie po usunięciu konta użytkownika?

Stan użytkownika jest ustawiony na "nieaktywny" po usunięciu konta użytkownika. Pozostaje w ten sposób przez 30 dni, po którym konto użytkownika i skojarzone z nim dane są czyszczone i nie do odzyskania. Jeśli chcesz przywrócić usunięte konto użytkownika w ciągu 30 dni, zobacz Przywracanie usuniętego użytkownika dla klienta. Po usunięciu i oznaczeniu jako "nieaktywne" konto użytkownika nie jest już zwracane jako członek kolekcji użytkowników (na przykład przy użyciu polecenia Pobierz listę wszystkich kont użytkowników dla klienta). Aby uzyskać listę usuniętych użytkowników, którzy nie zostali jeszcze przeczyszczeni, należy wykonać zapytanie dotyczące kont użytkowników, które zostały ustawione na nieaktywne.

C#

Aby pobrać listę usuniętych użytkowników, należy utworzyć zapytanie filtrujące dla użytkowników klientów, których stan jest ustawiony na nieaktywny. Najpierw utwórz filtr, tworząc wystąpienie obiektu SimpleFieldFilter z parametrami, jak pokazano w poniższym fragmencie kodu. Następnie utwórz zapytanie przy użyciu metody BuildIndexedQuery. Jeśli nie chcesz stronicować wyników, możesz zamiast tego użyć metody BuildSimpleQuery. Następnie użyj metody IAggregatePartner.Customers.ById z identyfikatorem klienta, aby zidentyfikować klienta. Na koniec wywołaj metodę Query , aby wysłać żądanie.

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

Przykład: aplikacja testowa konsoli. Projekt: Klasa przykładów zestawu SDK Centrum partnerskiego: GetCustomerInactiveUsers.cs

Żądanie REST

Składnia żądania

Metoda	Identyfikator URI żądania
GET	{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

Parametr identyfikatora URI

Podczas tworzenia żądania użyj następującej ścieżki i parametrów zapytania.

Nazwisko	Type	Wymagania	opis
identyfikator klienta	Identyfikator GUID	Tak	Wartość jest identyfikatorem GUID sformatowanym przez klienta, który identyfikuje klienta.
size	int	Nie.	Liczba wyników, które mają być wyświetlane jednocześnie. Ten parametr jest opcjonalny.
filtr	filtr	Tak	Zapytanie, które filtruje wyszukiwanie użytkownika. Aby pobrać usuniętych użytkowników, musisz dołączyć i zakodować następujący ciąg: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Przykład żądania

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

Odpowiedź REST

Jeśli ta metoda powiedzie się, zwraca kolekcję zasobów CustomerUser w treści odpowiedzi.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykład odpowiedzi

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"
    }
}

Udostępnij za pośrednictwem