Problema

Como não há um recurso de relatório de usuários na Plataforma Senior X, como realizar uma chamada via API para listagem das informações dos usuários que estão cadastrados na Gestão de Usuários?

Resolução

Você pode realizar uma chamada da API listUsers/ da Plataforma, onde a mesma irá trazer uma lista de usuários que contém uma relação de todas as informações de cada usuário.

A API listUsers é uma API pública e você pode validar a execução da mesma diretamente pelo Portal do Dev.

Exemplo do retorno obtido com a requisição da API diretamente.

Para verificar como realizar as requisições das APIs diretamente pelo portal, acesse Este Tutorial.

Abaixo segue um exemplo de como realizar uma parametrização da API diretamente pelo Portal do Dev.

Onde:

• Tenant - Nome do tenant que está sendo realizada a pesquisa
• pageNumber: Número da página de consulta caso o resultado da consulta seja paginado. É recomendado que seja realizada a paginação no caso de uma consulta que retorne muitos resultados para que a consulta não seja abortada pelo time out da Plataforma.
• pageSize: Quantidade de registros que devem ser recuperados por página.
• sortBy: Definição do campo de ordenação dos resultados. No exemplo acima, o resultado está sendo ordenado pelo campo "username". Ou seja, as informações serão ordenadas pelo valor do nome de usuário.
• sortOrder: Tipo da ordenação - asc para ascendente, desc para descendente
• includeBlocked: Indica se os usuários deverão ou não ser listados - true para incluir os usuários bloqueados, false para não listar os usuários bloqueados.

Exemplo de retorno da requisição realizada acima

Caso deseje, você também pode realizar o download dos resultados obtidos através do botão "Download". Isso irá gerar um arquivo no formato .json que poderá utilizar depois para conferência ou exportá lo para alguma aplicação terceira.

Lembrando que a exportação para esta aplicação terceira é de responsabilidade do cliente.

Como valido o nome do Tenant?

• Acesse a Plataforma Senior X com o usuário admin
• Acesse o menu Tecnologia > Administração > Gestão dos Tenants > Configurar
• Os valors que você irá utilizar é apresentado como "Tenant" (nome do Tenant) e "Domínio" (Domínio do Tenant) na tela de Gestão.