Visualizzare gli utenti eliminati per un cliente

Articolo
09/11/2024

Ottiene un elenco di risorse CustomerUser eliminate per un cliente in base all'ID cliente. Facoltativamente, è possibile impostare una dimensione della pagina. È necessario specificare un filtro.

Prerequisiti

Credenziali descritte in Autenticazione del Centro per i partner. Questo scenario supporta l'autenticazione solo con le credenziali app + utente.
ID cliente (customer-tenant-id). Se non si conosce l'ID del cliente, è possibile cercarlo nel Centro per i partner selezionando l'area di lavoro Clienti , quindi il cliente dall'elenco dei clienti, quindi Account. Nella pagina Account del cliente cercare l'ID Microsoft nella sezione Informazioni sull'account del cliente. L'ID Microsoft corrisponde all'ID del cliente (customer-tenant-id).

Cosa accade quando si elimina un account utente?

Lo stato utente è impostato su "inattivo" quando si elimina un account utente. Rimane così per 30 giorni, dopo i quali l'account utente e i relativi dati associati vengono eliminati e resi irreversibili. Per ripristinare un account utente eliminato all'interno della finestra di 30 giorni, vedere Ripristinare un utente eliminato per un cliente. Una volta eliminato e contrassegnato come "inattivo", l'account utente non viene più restituito come membro della raccolta di utenti( ad esempio, usando Ottieni un elenco di tutti gli account utente per un cliente). Per ottenere un elenco di utenti eliminati che non sono ancora stati eliminati, è necessario eseguire una query per gli account utente impostati su inattivi.

C#

Per recuperare un elenco di utenti eliminati, creare una query che filtra per gli utenti dei clienti il cui stato è impostato su inattivo. Creare prima di tutto il filtro creando un'istanza di un oggetto SimpleFieldFilter con i parametri, come illustrato nel frammento di codice seguente. Creare quindi la query usando il metodo BuildIndexedQuery. Se non si vogliono risultati su più pagine, è possibile usare invece il metodo BuildSimpleQuery. Usare quindi il metodo IAggregatePartner.Customers.ById con l'ID cliente per identificare il cliente. Infine, chiamare il metodo Query per inviare la richiesta.

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

Esempio: App di test della console. Project: Partner Center SDK Samples Class: GetCustomerInactiveUsers.cs

Richiesta REST

Sintassi della richiesta

metodo	URI della richiesta
GET	{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

Parametro URI

Usare il percorso e i parametri di query seguenti durante la creazione della richiesta.

Nome	Digita	Obbligatorio	Descrizione
customer-id	guid	Sì	Il valore è un ID cliente formattato con GUID che identifica il cliente.
size	int	No	Numero di risultati da visualizzare contemporaneamente. Il parametro è facoltativo.
filter	filter	Sì	Query che filtra la ricerca di utenti. Per recuperare gli utenti eliminati, è necessario includere e codificare la stringa seguente: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

Intestazioni delle richieste

Per altre informazioni, vedi Intestazioni REST del Centro per i partner.

Corpo della richiesta

Nessuno.

Esempio di richiesta

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

Risposta REST

In caso di esito positivo, questo metodo restituisce una raccolta di risorse CustomerUser nel corpo della risposta.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che ne indica l'esito e con informazioni di debug aggiuntive. Usa uno strumento di traccia di rete per leggere il codice, il tipo di errore e parametri aggiuntivi. Per l'elenco completo, vedi Codici di errore REST del Centro per i partner.

Risposta di esempio

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

Condividi tramite