> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/api-inc-cloud/usuarios.md).
# Usuários
Endpoints relacionados aos usuários e seus sites
## Obter sites gerenciáveis do usuário
> Lista os sites (lojas) que o usuário autenticado pode gerenciar, com endereço, telefone e cenário de cada um. Use o \`shopId\` retornado aqui como filtro nos demais endpoints.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Usuários","description":"Endpoints relacionados aos usuários e seus sites"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/user/shop":{"get":{"tags":["Usuários"],"summary":"Obter sites gerenciáveis do usuário","parameters":[{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string"},"shopId":{"type":"integer"},"shopName":{"type":"string"},"province":{"type":"string"},"city":{"type":"string"},"area":{"type":"string"},"address":{"type":"string"},"phone":{"type":"string"},"scenarioName":{"type":"string"},"columns":{"type":"object","nullable":true}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Lista os sites (lojas) que o usuário autenticado pode gerenciar, com endereço, telefone e cenário de cada um. Use o `shopId` retornado aqui como filtro nos demais endpoints.","operationId":"listUserSites"}}}}
```
## Obter histórico de autenticação
> Retorna o histórico de autenticações de usuários no portal cativo dos sites informados, de forma paginada.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Usuários","description":"Endpoints relacionados aos usuários e seus sites"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/api/o2oportal/getAuthUserInfo":{"post":{"tags":["Usuários"],"summary":"Obter histórico de autenticação","responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"total_count":{"type":"integer"},"page_size":{"type":"integer"},"page_index":{"type":"integer"},"auth_list":{"type":"array","items":{"type":"object","properties":{"ap_group_id":{"type":"string","nullable":true},"ap_mac":{"type":"string","nullable":true},"upstream":{"type":"integer"},"downstream":{"type":"integer"},"user_group":{"type":"string","nullable":true},"shop_id":{"type":"integer"},"user_type":{"type":"integer"},"access_start_time":{"type":"integer"},"access_duration":{"type":"integer"},"access_ssid":{"type":"string","nullable":true},"access_ac_ip":{"type":"integer"},"user_mac":{"type":"string"},"user_ip":{"type":"integer"},"vendor":{"type":"string","nullable":true},"terminal_model":{"type":"string","nullable":true},"login_freq_sum":{"type":"integer"},"access_duration_sum":{"type":"integer"},"upstream_sum":{"type":"integer"},"downstream_sum":{"type":"integer"},"offline_type":{"type":"integer"},"user_name":{"type":"string"},"app_auth_id":{"type":"string","nullable":true},"app_account":{"type":"string","nullable":true},"preliminary":{"type":"string","nullable":true},"mobile_decode":{"type":"string","nullable":true}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shop_id":{"type":"array","items":{"type":"integer"}},"begin_time":{"type":"integer"},"end_time":{"type":"integer"},"page_size":{"type":"integer"},"page_index":{"type":"integer"}},"required":["shop_id","begin_time","end_time"]}}}},"description":"Retorna o histórico de autenticações de usuários no portal cativo dos sites informados, de forma paginada.","operationId":"listPortalAuthHistory"}}}}
```
## Obter árvore de regiões do usuário
> Retorna todas as regiões (agrupamentos hierárquicos de sites) pertencentes ao usuário, já\
> estruturadas com \`parentId\` e \`level\`, permitindo montar a árvore completa no cliente.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Usuários","description":"Endpoints relacionados aos usuários e seus sites"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/regioninfo/regions":{"get":{"tags":["Usuários"],"summary":"Obter árvore de regiões do usuário","description":"Retorna todas as regiões (agrupamentos hierárquicos de sites) pertencentes ao usuário, já\nestruturadas com `parentId` e `level`, permitindo montar a árvore completa no cliente.\n","parameters":[{"name":"user_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","required":true,"description":"Idioma da resposta. Envie `en` para receber textos em inglês.","schema":{"type":"string","enum":["en"]}}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identificador da região (usado como `regionId` em outros endpoints)."},"ownerId":{"type":"integer","description":"Identificador do usuário dono da região."},"name":{"type":"string"},"parentId":{"type":"integer","description":"Identificador da região pai (ausente na região raiz)."},"checked":{"type":"boolean"},"level":{"type":"integer","description":"Profundidade da região na hierarquia (1 = raiz)."}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getRegionTree"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://portal-integracao.intelbras.com.br/api-inc-cloud/usuarios.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.