Visa borttagna användare för en kund
Hämtar en lista över borttagna CustomerUser-resurser för en kund efter kund-ID. Du kan också ange en sidstorlek. Du måste ange ett filter.
Förutsättningar
Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder endast autentisering med App+User-autentiseringsuppgifter.
Ett kund-ID (
customer-tenant-id
). Om du inte känner till kundens ID kan du söka efter det i Partnercenter genom att välja arbetsytan Kunder , sedan kunden från kundlistan och sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id
).
Vad händer när du tar bort ett användarkonto?
Användartillståndet är inställt på "inaktivt" när du tar bort ett användarkonto. Det är fortfarande så i 30 dagar, varefter användarkontot och dess associerade data rensas och görs oåterkalleliga. Om du vill återställa ett borttaget användarkonto i 30-dagarsfönstret kan du läsa Återställa en borttagen användare för en kund. När användarkontot har tagits bort och markerats som "inaktivt" returneras det inte längre som medlem i användarsamlingen (till exempel genom att använda Hämta en lista över alla användarkonton för en kund). Om du vill hämta en lista över borttagna användare som ännu inte har rensats måste du fråga efter användarkonton som har angetts som inaktiva.
C#
Om du vill hämta en lista över borttagna användare skapar du en fråga som filtrerar för kundanvändare vars status är inställd på inaktiv. Skapa först filtret genom att instansiera ett SimpleFieldFilter-objekt med parametrarna enligt följande kodfragment. Skapa sedan frågan med metoden BuildIndexedQuery. Om du inte vill ha sidsidiga resultat kan du använda metoden BuildSimpleQuery i stället. Använd sedan metoden IAggregatePartner.Customers.ById med kund-ID:t för att identifiera kunden. Anropa slutligen query-metoden för att skicka begäran.
// 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);
Exempel: Konsoltestapp. Projekt: SDK-exempelklass för Partnercenter: GetCustomerInactiveUsers.cs
REST-begäran
Syntax för begäran
Metod | URI för förfrågan |
---|---|
GET | {baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1 |
URI-parameter
Använd följande sökväg och frågeparametrar när du skapar begäran.
Namn | Typ | Obligatoriskt | Beskrivning |
---|---|---|---|
kund-ID | guid | Ja | Värdet är ett GUID-formaterat kund-ID som identifierar kunden. |
storlek | heltal | Nej | Antalet resultat som ska visas samtidigt. Den här parametern är valfri. |
filter | filter | Ja | Frågan som filtrerar användarsökningen. Om du vill hämta borttagna användare måste du inkludera och koda följande sträng: {"Field":"UserState","Value":"Inactive","Operator":"equals"}. |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Begärandetext
Inga.
Exempel på begäran
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-svar
Om det lyckas returnerar den här metoden en samling CustomerUser-resurser i svarstexten.
Svarsframgång och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. Den fullständiga listan finns i Rest-felkoder för Partnercenter.
Svarsexempel
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"
}
}