Verwijderde gebruikers voor een klant weergeven

Artikel
03/06/2024

Hiermee haalt u een lijst op met verwijderde CustomerUser-resources voor een klant op basis van klant-id. U kunt desgewenst een paginaformaat instellen. U moet een filter opgeven.

Vereisten

Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario biedt alleen ondersteuning voor verificatie met app+gebruikersreferenties.
Een klant-id (customer-tenant-id). Als u de klant-id niet weet, kunt u deze opzoeken in het Partnercentrum door de werkruimte Klanten te selecteren, vervolgens de klant in de lijst met klanten en vervolgens Account. Zoek op de pagina Account van de klant naar de Microsoft-id in de sectie Klantaccountgegevens . De Microsoft-id is hetzelfde als de klant-id (customer-tenant-id).

Wat gebeurt er wanneer u een gebruikersaccount verwijdert?

De gebruikersstatus wordt ingesteld op 'inactief' wanneer u een gebruikersaccount verwijdert. Het blijft zo 30 dagen, waarna het gebruikersaccount en de bijbehorende gegevens worden verwijderd en onherstelbaar worden gemaakt. Als u een verwijderd gebruikersaccount in het venster van 30 dagen wilt herstellen, raadpleegt u Een verwijderde gebruiker voor een klant herstellen. Zodra het gebruikersaccount is verwijderd en gemarkeerd als 'inactief', wordt het gebruikersaccount niet meer geretourneerd als lid van de gebruikersverzameling (bijvoorbeeld door een lijst met alle gebruikersaccounts voor een klant op te halen). Als u een lijst met verwijderde gebruikers wilt ophalen die nog niet zijn opgeschoond, moet u een query uitvoeren op gebruikersaccounts die zijn ingesteld op inactief.

C#

Als u een lijst met verwijderde gebruikers wilt ophalen, maakt u een query die filtert op klantgebruikers waarvan de status is ingesteld op inactief. Maak eerst het filter door een SimpleFieldFilter-object te instantiëren met de parameters, zoals wordt weergegeven in het volgende codefragment. Maak vervolgens de query met behulp van de methode BuildIndexedQuery. Als u geen paginaresultaten wilt, kunt u in plaats daarvan de methode BuildSimpleQuery gebruiken. Gebruik vervolgens de methode IAggregatePartner.Customers.ById met de klant-id om de klant te identificeren. Roep tot slot de querymethode aan om de aanvraag te verzenden.

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

Voorbeeld: consoletest-app. Project: Voorbeeldklasse Partner Center SDK: GetCustomerInactiveUsers.cs

REST-aanvraag

Aanvraagsyntaxis

Wijze	Aanvraag-URI
GET	{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

URI-parameter

Gebruik het volgende pad en queryparameters bij het maken van de aanvraag.

Name	Type	Vereist	Beschrijving
klant-id	guid	Ja	De waarde is een door de GUID opgemaakte klant-id waarmee de klant wordt geïdentificeerd.
size	int	Nee	Het aantal resultaten dat tegelijk moet worden weergegeven. Deze parameter is optioneel.
filter	filter	Ja	De query waarmee de zoekopdracht van de gebruiker wordt gefilterd. Als u verwijderde gebruikers wilt ophalen, moet u de volgende tekenreeks opnemen en coderen: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

Geen.

Aanvraagvoorbeeld

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-antwoord

Als dit lukt, retourneert deze methode een verzameling CustomerUser-resources in de hoofdtekst van het antwoord.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat de fout is geslaagd of mislukt en aanvullende informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en aanvullende parameters te lezen. Zie rest-foutcodes in Partnercentrum voor de volledige lijst.

Responsvoorbeeld

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

Delen via