View deleted users for a customer (Ver los usuarios eliminados de un cliente)

Artículo
03/06/2024

Obtiene una lista de recursos CustomerUser eliminados para un cliente por identificador de cliente. Opcionalmente, puede establecer un tamaño de página. Debe proporcionar un filtro.

Requisitos previos

Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación solo con credenciales de aplicación y usuario.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners seleccionando el área de trabajo Clientes , luego el cliente de la lista de clientes y, a continuación , Cuenta. En la página Cuenta del cliente, busque el identificador de Microsoft en la sección Información de la cuenta de cliente. El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).

¿Qué ocurre al eliminar una cuenta de usuario?

El estado de usuario se establece en "inactivo" al eliminar una cuenta de usuario. Sigue siendo así durante 30 días, después de lo cual la cuenta de usuario y sus datos asociados se purgan y hacen irrecuperables. Si desea restaurar una cuenta de usuario eliminada dentro de la ventana de 30 días, consulte Restauración de un usuario eliminado para un cliente. Una vez eliminado y marcado como "inactivo", la cuenta de usuario ya no se devuelve como miembro de la colección de usuarios (por ejemplo, mediante Obtener una lista de todas las cuentas de usuario de un cliente). Para obtener una lista de usuarios eliminados que aún no se han purgado, debe consultar las cuentas de usuario que se han establecido en inactivas.

C#

Para recuperar una lista de usuarios eliminados, cree una consulta que filtre por los usuarios del cliente cuyo estado esté establecido en inactivo. En primer lugar, cree el filtro creando una instancia de un objeto SimpleFieldFilter con los parámetros, como se muestra en el siguiente fragmento de código. A continuación, cree la consulta mediante el método BuildIndexedQuery. Si no quiere resultados paginados, puede usar el método BuildSimpleQuery. A continuación, use el método IAggregatePartner.Customers.ById con el identificador de cliente para identificar al cliente. Por último, llame al método Query para enviar la solicitud.

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

Ejemplo: Aplicación de prueba de consola. Project: Clase de ejemplos del SDK del Centro de partners: GetCustomerInactiveUsers.cs

Solicitud REST

Sintaxis de la solicitud

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

Parámetro de URI

Use la siguiente ruta de acceso y parámetros de consulta al crear la solicitud.

Nombre	Type	Obligatorio	Descripción
customer-id	guid	Sí	El valor es un identificador de cliente con formato GUID que identifica al cliente.
size	int	No	El número de resultados que se van a mostrar al mismo tiempo. Este parámetro es opcional.
filter	filter	Sí	Consulta que filtra la búsqueda de usuario. Para recuperar usuarios eliminados, debe incluir y codificar la cadena siguiente: {"Field":"UserState","Value":"Inactive","Operator":"equals"}.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

Ninguno.

Ejemplo de solicitud

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

Respuesta REST

Si se ejecuta correctamente, este método devuelve una colección de recursos CustomerUser en el cuerpo de la respuesta.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.

Ejemplo de respuesta

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