Pular para o conteúdo principal

Excluir usuário

Remove o usuário autenticado dentro do escopo de rede do seu token de acesso de usuário.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado

Headers#

3
AuthorizationstringObrigatório
Aceito ou encaminhado pelo API Gateway para esta operação.
X-Device-IdstringOpcional
Aceito ou encaminhado pelo API Gateway para esta operação.
X-Merchant-IdstringOpcional
Aceito ou encaminhado pelo API Gateway para esta operação.

Parâmetros de rota#

1
user_idstring<uuid>Obrigatório
Valor que substitui `user_id` na rota do endpoint.

Corpo da solicitação#

0
Este endpoint não aceita corpo de solicitação.

Resposta#

6
204A solicitação foi aceita ou concluída. Confira o payload para o resultado de negócio.
400A solicitação é inválida ou falhou na validação.
401As credenciais ou o contexto do chamador são inválidos.
404O recurso ou a rota solicitada não foi encontrado.
500O serviço não concluiu a solicitação. Tente novamente apenas quando a operação for segura ou idempotente.
503O serviço não concluiu a solicitação. Tente novamente apenas quando a operação for segura ou idempotente.

Antes de excluir um usuário#

  • Obtenha o token de acesso de usuário do cliente pelo fluxo de autenticação.
  • Defina o ID de usuário da rota como o UUID do cliente autenticado. Um cliente só pode excluir seu próprio usuário.
  • Confirme que o cliente deseja remover sua conta da rede associada a esse token.

Entenda o escopo da exclusão#

Com um token restrito a uma rede, a exclusão remove a associação do usuário e seus endereços nessa rede e solicita a remoção dos seus cartões na mesma rede. Isso não implica a exclusão de todas as redes da DEUNA. Um token de conta com escopo geral da DEUNA também remove a conta e suas associações de rede. Uma exclusão bem-sucedida remove as sessões ativas do usuário.

Não interprete esta operação como confirmação de que todos os registros históricos de pagamentos ou todos os dados pessoais foram apagados. Confirme o escopo necessário de remoção de conta e dados com seu Technical Account Manager da DEUNA antes de criar um fluxo de encerramento de conta.

Envie a solicitação de exclusão#

Use a URL base de sandbox abaixo para testes e https://api.deuna.io para produção. Envie o token Bearer do cliente no cabeçalho Authorization. O endpoint não tem parâmetros de consulta nem corpo de solicitação.

curl --request DELETE \
  --url 'https://api.sandbox.deuna.io/users/USER_ID' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN'

Verifique o resultado#

Uma solicitação bem-sucedida retorna HTTP 204 No Content com corpo vazio. Limpe a sessão local do cliente e apresente a experiência sem sessão iniciada. Não interprete a resposta como JSON nem aguarde um webhook de pagamento para confirmar esta operação.

Trate erros e resultados incertos#

HTTP 400 pode indicar que o usuário da rota é diferente do usuário do token. HTTP 401 significa que o token de usuário não pode autorizar a solicitação; HTTP 404 significa que o registro solicitado não foi encontrado. Corrija a solicitação ou a autenticação antes de tentar novamente.

Um tempo limite ou erro do servidor pode ocorrer depois que parte da exclusão já teve efeito. HTTP 503 pode ocorrer durante a limpeza das sessões após a exclusão. Não presuma que uma nova tentativa retornará a mesma resposta nem repita a solicitação automaticamente. Verifique o estado da conta com o suporte da DEUNA quando o resultado for incerto. Não há contrato de chave de idempotência definido para esta operação.

Veja códigos de resposta e solução de problemas para orientações gerais sobre tratamento de erros.