Afficher les utilisateurs supprimés d’un client

Article
03/06/2024

Obtient la liste des ressources CustomerUser supprimées pour un client par ID client. Vous pouvez éventuellement définir une taille de page. Vous devez fournir un filtre.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur uniquement.
ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page Compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).

Que se passe-t-il quand vous supprimez un compte d’utilisateur ?

L’état utilisateur est défini sur « inactif » lorsque vous supprimez un compte d’utilisateur. Il reste cette façon pendant 30 jours, après quoi le compte d’utilisateur et ses données associées sont vidés et rendus irrécupérables. Si vous souhaitez restaurer un compte d’utilisateur supprimé dans la fenêtre de 30 jours, consultez Restaurer un utilisateur supprimé pour un client. Une fois supprimé et marqué « inactif », le compte d’utilisateur n’est plus retourné en tant que membre de la collection d’utilisateurs (par exemple, en utilisant obtenir la liste de tous les comptes d’utilisateur pour un client). Pour obtenir la liste des utilisateurs supprimés qui n’ont pas encore été vidés, vous devez rechercher les comptes d’utilisateur qui ont été définis sur inactifs.

C#

Pour récupérer une liste d’utilisateurs supprimés, créez une requête qui filtre les utilisateurs clients dont l’état est défini sur inactif. Tout d’abord, créez le filtre en instanciant un objet SimpleFieldFilter avec les paramètres, comme indiqué dans l’extrait de code suivant. Créez ensuite la requête à l’aide de la méthode BuildIndexedQuery. Si vous ne souhaitez pas obtenir des résultats paginés, vous pouvez utiliser la méthode BuildSimpleQuery à la place. Ensuite, utilisez la méthode IAggregatePartner.Customers.ById avec l’ID client pour identifier le client. Enfin, appelez la méthode Query pour envoyer la requête.

// 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 de console. Projet : Classe d’exemples sdk de l’Espace partenaires : GetCustomerInactiveUsers.cs

Demande REST

Syntaxe de la requête

Méthode	URI de demande
GET	{baseURL}/v1/customers/{customer-id}/users ?size={size}&filter={filter} HTTP/1.1

Paramètre d’URI

Utilisez le chemin d’accès et les paramètres de requête suivants lors de la création de la requête.

Nom	Type	Requise	Description
id-client	guid	Oui	La valeur est un ID client au format GUID qui identifie le client.
size	int	Non	Nombre de résultats à afficher en même temps. Ce paramètre est facultatif.
filter	filter	Oui	La requête qui filtre la recherche de l’utilisateur. Pour récupérer des utilisateurs supprimés, vous devez inclure et encoder la chaîne suivante : {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Aucun.

Exemple de requête

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 REST

Si elle réussit, cette méthode retourne une collection de ressources CustomerUser dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

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. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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

Partager via