Visualizar usuários excluídos para um cliente

Obtém uma lista de recursos CustomerUser excluídos para um cliente por ID de cliente. Opcionalmente, você pode definir um tamanho de página. Você deve fornecer um filtro.

Pré-requisitos

• Credenciais, conforme descrito em Autenticação do Partner Center. Este cenário dá suporte somente à autenticação com credenciais de aplicativo + de usuário.

• Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o espaço de trabalho Clientes, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).

O que acontece quando você exclui uma conta de usuário?

O estado do usuário é definido como "inativo" quando você exclui uma conta de usuário. Ele permanece assim por 30 dias, após os quais a conta de usuário e seus dados associados são limpos e tornados irrecuperáveis. Se você quiser restaurar uma conta de usuário excluída dentro da janela de 30 dias, consulte Restaurar um usuário excluído para um cliente. Depois de excluída e marcada como "inativa", a conta de usuário não é mais retornada como membro da coleção de usuários (por exemplo, usando Obter uma lista de todas as contas de usuário de um cliente). Para obter uma lista de usuários excluídos que ainda não foram removidos, você deve consultar contas de usuário que foram definidas como inativas.

C#

Para recuperar uma lista de usuários excluídos, construa uma consulta que filtre os usuários do cliente cujo status está definido como inativo. Primeiro, crie o filtro instanciando um objeto SimpleFieldFilter com os parâmetros, conforme mostrado no trecho de código a seguir. Em seguida, crie a consulta usando o método BuildIndexedQuery. Se você não quiser resultados paginados, poderá usar o método BuildSimpleQuery. Em seguida, use o método IAggregatePartner.Customers.ById com a ID do cliente para identificar o cliente. Finalmente, chame o método Query para enviar a solicitação.

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

Exemplo: Aplicativo de teste de console. Projeto: Exemplos de SDK do Partner Center Classe: GetCustomerInactiveUsers.cs

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/customers/{customer-id}/users?size={size}&filter={filter} HTTP/1.1

Parâmetro do URI

Use o seguinte caminho e parâmetros de consulta ao criar a solicitação.

Nome	Digitar	Obrigatória	Descrição
id do cliente	guid	Sim	O valor é um ID de cliente formatado por GUID que identifica o cliente.
tamanho	int	Não	O número de resultados a serem exibidos ao mesmo tempo. Esse parâmetro é opcional.
filtro	filtro	Sim	A consulta que filtra a pesquisa de usuário. Para recuperar usuários excluídos, você deve incluir e codificar a cadeia de caracteres a seguir: {"Campo": "UserState", "Valor": "Inativo", "Operador": "igual a"}.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Exemplo de solicitação

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

Resposta REST

Se bem-sucedido, esse método retorna uma coleção de recursos CustomerUser no corpo da resposta.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplo de resposta

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