Afficher les utilisateurs supprimés d’un clientView deleted users for a customer

S’applique àApplies To

  • Espace partenairesPartner Center

Obtient une liste de ressources CustomerUser supprimées pour un client par ID de client.Gets a list of deleted CustomerUser resources for a customer by customer ID. Vous pouvez éventuellement définir une taille de page.You can optionally set a page size. Vous devez fournir un filtre.You must supply a filter.

PrérequisPrerequisites

  • Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires.Credentials as described in Partner Center authentication. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur uniquement.This scenario supports authentication with App+User credentials only.

  • ID du client (customer-tenant-id).A customer ID (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans le tableau de bord de l’Espace partenaires.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Sélectionnez CSP dans le menu Espace partenaires, puis Clients.Select CSP from the Partner Center menu, followed by Customers. Sélectionnez le client dans la liste des clients, puis Compte.Select the customer from the customer list, then select Account. Dans la page du compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

Que se passe-t-il lorsque vous supprimez un compte d’utilisateur ?What happens when you delete a user account?

Lorsque vous supprimez un compte d’utilisateur, l’état de l’utilisateur est défini sur « inactif ».The user state is set to "inactive" when you delete a user account. Elle reste ainsi pendant trente jours, après quoi le compte d’utilisateur et ses données associées sont purgés et rendus irrécupérables.It remains that way for thirty days, after which the user account and its associated data are purged and made unrecoverable. Si vous souhaitez restaurer un compte d’utilisateur supprimé au cours de la période de 30 jours, consultez restaurer un utilisateur supprimé pour un client.If you want to restore a deleted user account within the thirty day window, see Restore a deleted user for a customer. Une fois supprimée et marquée comme « inactive », le compte d’utilisateur n’est plus renvoyé en tant que membre du regroupement d’utilisateurs (par exemple, à l’aide de la fonction obtenir une liste de tous les comptes d’utilisateurs d’un client).Once deleted and marked "inactive", the user account is no longer returned as a member of the user collection (for example, using Get a list of all user accounts for a customer). Pour obtenir la liste des utilisateurs supprimés qui n’ont pas encore été purgés, vous devez rechercher les comptes d’utilisateur qui ont été définis comme étant inactifs.To get a list of deleted users that have not yet been purged, you must query for user accounts that have been set to inactive.

C#C#

Pour récupérer une liste d’utilisateurs supprimés, construisez une requête qui filtre les utilisateurs dont l’État est défini sur inactif.To retrieve a list of deleted users, construct a query that filters for customer users whose status is set to inactive. Tout d’abord, créez le filtre en instanciant un objet SimpleFieldFilter avec les paramètres, comme indiqué dans l’extrait de code suivant.First, create the filter by instantiating a SimpleFieldFilter object with the parameters as shown in the following code snippet. Ensuite, créez la requête à l’aide de la méthode BuildIndexedQuery .Then create the query using the BuildIndexedQuery method. Si vous ne souhaitez pas obtenir de résultats paginés, vous pouvez utiliser la méthode BuildSimpleQuery à la place.If you do not want paged results, you can use the BuildSimpleQuery method instead. Ensuite, utilisez la méthode collection iaggregatepartner. Customers. méthode BYID avec l’ID client pour identifier le client.Next, use the IAggregatePartner.Customers.ById method with the customer ID to identify the customer. Enfin, appelez la méthode query pour envoyer la demande.Finally, call the Query method to send the request.

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

Exemple: application de test console.Sample: Console test app. Projet: classed’exemples du kit de développement logiciel (SDK) Partner Center : GetCustomerInactiveUsers.csProject: Partner Center SDK Samples Class: GetCustomerInactiveUsers.cs

Demande RESTREST request

Syntaxe de la requêteRequest syntax

MéthodeMethod URI de requêteRequest URI
GETGET {baseURL}/v1/Customers/{Customer-ID}/Users ? Size = {size} &filtre = {filter} http/1.1{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

Paramètre d’URIURI parameter

Utilisez le chemin d’accès et les paramètres de requête suivants lors de la création de la demande.Use the following path and query parameters when creating the request.

NomName TypeType ObligatoireRequired DescriptionDescription
customer-idcustomer-id guidguid OuiYes La valeur est un ID client au format GUID qui identifie le client.The value is a GUID formatted customer-id that identifies the customer.
taillesize intint NonNo Nombre de résultats à afficher en même temps.The number of results to be displayed at one time. Ce paramètre est optionnel.This parameter is optional.
filterfilter filterfilter OuiYes La requête qui filtre la recherche de l’utilisateur.The query that filters the user search. Pour récupérer des utilisateurs supprimés, vous devez inclure et encoder la chaîne suivante : {"Field":"UserState","Value":"Inactive","Operator":"equals"}.To retrieve deleted users, you must include and encode the following string: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

En-têtes de requêteRequest headers

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.For more information, see Partner Center REST headers.

Corps de demandeRequest body

Aucun.None.

Exemple de requêteRequest example

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

Réponse RESTREST response

En cas de réussite, cette méthode retourne une collection de ressources CustomerUser dans le corps de la réponse.If successful, this method returns a collection of CustomerUser resources in the response body.

Codes d’erreur et de réussite de la réponseResponse success and error codes

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires.Use a network trace tool to read this code, error type, and additional parameters. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.For the full list, see Partner Center REST error codes.

Exemple de réponseResponse example

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