Excluir usuário

Excluir usuário #

Exclui um usuário existente do locatário Cliente.

Se esse for o locatário não primário de um usuário, ele o removerá apenas desse locatário. Eles ainda terão acesso a qualquer outro Cliente que lhes seja atribuído.

Se este for o locatário principal do usuário, ele o removerá de ALL outros locatários do Cliente e exclua a conta do Usuário.

Pedir #

DELETE /v1.0/clientes/{CUSTOMER_TENANT_ID}/usuários/{USER_ID}

Exemplo #

Essa solicitação excluirá o usuário específico no locatário do cliente.

Pedir #

DELETE <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}> HTTP/1.1
Autorização: Portador {TOKEN}

Resposta #

HTTP/1.1 200 OK
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
{
	"status": "sucesso",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Desautorizado #

Quando o token não é fornecido, é inválido ou expirado

HTTP/1.1 401 Não autorizado

Solicitação incorreta (1) #

Quando a ID do locatário fornecida não está no formato correto

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro":400,
	"message":"O valor '<tenant id>' não é válido.",
	"status":"erro",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Solicitação incorreta (2) #

Quando o ID de usuário fornecido não está no formato correto

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro":400,
	"message":"O valor '<user id>' não é válido.",
	"status":"erro",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há clientes que tenham uma ID de locatário correspondente ou Usuários com a ID de usuário

HTTP/1.1 404 Não encontrado
Data: Qui, 06 de fevereiro de 2020 12:46:58 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 95
{
	"erro":404,
	"message":"Não encontrado",
	"status":"erro",
	"timestamp": "2020-02-06T12: 46: 58.7669535Z"
}

Solicitação incorreta #

Quando o último usuário com a função "user.admin" e "customer.user" neste cliente tenta remover essa função.

Hand Left warning
Sempre é necessário haver um usuário em um locatário do cliente com as funções "user.admin" e "customer.user".
HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 Fev 2020 13:12:06 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 132
{
	"erro": 400,
	"message": "Deve haver pelo menos um administrador de usuários.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T13:12:06.9741515Z"
}