Obter todos (usuários)

Obter todos (usuários) #

Obtém todos os usuários para um locatário do cliente.

GET /v1.0/clientes/{CUSTOMER_TENANT_ID}/usuários

Exemplo #

Essa solicitação obterá todos os usuários do locatário do cliente fornecido.

Pedir # 

GET [https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/usuários](https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users) 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
{
	"page_size": 2,
	"dados": [ {
			"id": "{USER_ID_1}",
			"displayName": "Usuário 1",
			"email": "[email protected]",
			"primaryTenant": "{CUSTOMER_TENANT_ID}",
			"éPai": falso
		}, {
			"id": "{USER_ID_2}",
			"displayName": "Usuário 2",
			"email": "[email protected]",
			"primaryTenant": "{CUSTOMER_TENANT_ID}",
			"éPai": falso
		}
	][{
			"id": "{USER_ID_1}",
			"displayName": "User 1",
			"email": "[email protected]",
			"primaryTenant": "{CUSTOMER_TENANT_ID}",
			"isParent": false
		}, {
			"id": "{USER_ID_2}",
			"displayName": "User 2",
			"email": "[email protected]",
			"primaryTenant": "{CUSTOMER_TENANT_ID}",
			"isParent": false
		}
	],
	"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 #

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",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há clientes que tenham uma ID de locatário correspondente 

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",
	"carimbo de data/hora": "2020-02-06T12:46:58.7669535Z"
}