> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/pt-br/team-user-api/user-1.md).

# Usuário

## Visão geral

Usuários são indivíduos que pertencem a equipes e podem realizar várias ações dentro do Epsilon Retail Media sistema com base em suas permissões e funções.

### O que é um ID de usuário?

Um ID de usuário é um identificador exclusivo para cada usuário no Epsilon Retail Media sistema. Ele é necessário em solicitações de API para identificar e gerenciar usuários específicos, como atualizar detalhes do usuário, modificar permissões ou recuperar informações do usuário.

### Localizando seu ID de usuário

Para usar a API de Usuário, você precisará do seu ID de usuário. Ele identifica o usuário específico em solicitações de API. Você pode encontrá-lo ao:

1. Faça login no seu Citrus Client.
2. Clique no menu suspenso do perfil e selecione **Perfil do usuário**.
3. O ID de usuário é exibido na seção do perfil do usuário.

<figure><img src="/files/Z8twLrM5o0BX9038Kcmj" alt="" width="100%"><figcaption></figcaption></figure>

### Elementos do usuário

Cada usuário inclui os seguintes elementos principais:

| Elemento          | Descrição                                                   |
| ----------------- | ----------------------------------------------------------- |
| ID de usuário     | Um identificador exclusivo para o usuário.                  |
| E-mail            | O endereço de e-mail do usuário para login e notificações.  |
| Nome              | O primeiro nome do usuário.                                 |
| Sobrenome         | O sobrenome do usuário.                                     |
| ID do logotipo    | Identificador exclusivo da imagem de perfil do usuário.     |
| Membros da equipe | Lista de equipes às quais o usuário pertence.               |
| Permissões        | Nível de acesso e permissões do usuário dentro das equipes. |
| Status do convite | Status de convites de equipe pendentes.                     |

### Definições de campos da API de Usuário

A seguir estão os principais campos de usuário comumente usados em solicitações e respostas de API:

| Nome do campo      | Descrição                                                                                                                                                                                      |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                 | Identificador exclusivo do usuário.                                                                                                                                                            |
| email              | ID de e-mail do usuário.                                                                                                                                                                       |
| namespace          | Namespace ao qual o usuário pertence.                                                                                                                                                          |
| firstName          | Primeiro nome do usuário.                                                                                                                                                                      |
| lastName           | Sobrenome do usuário.                                                                                                                                                                          |
| logoUrl            | URL para a imagem de perfil ou logotipo do usuário. Você pode recuperar a logoUrl usando [Recuperar URL do arquivo](/retail-media-interface/partner/pt-br/team-user-api/user-1/getfileurl.md). |
| teamIds            | Lista dos IDs de equipe do usuário.                                                                                                                                                            |
| receivedInvitation | Detalhes dos convites pendentes.                                                                                                                                                               |
| inviteTeam         | Objeto raiz para o payload do convite.                                                                                                                                                         |
| managerTeamId      | ID exclusivo da equipe do varejista que gerencia o acesso e envia convites. Exemplo: manager-team-123.                                                                                         |
| roleIds            | Array de strings de permissão do usuário.                                                                                                                                                      |
| teamId             | ID da equipe para o convite do usuário.                                                                                                                                                        |
| retailerTeamId     | ID exclusivo do grupo gerenciado pelo varejista.                                                                                                                                               |
| offset             | Número de registros a serem ignorados antes de buscar os resultados.                                                                                                                           |

### Endpoints disponíveis

| Endpoint                                                                                      | Descrição                                                                                                                                                                                                                                                                                                                    |
| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Invite a user to the team](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)    | Envia um convite por e-mail para ingressar em uma equipe especificada. Requer o ID da equipe e o endereço de e-mail do usuário.                                                                                                                                                                                              |
| [Retrieve current user detail](/retail-media-interface/partner/pt-br/team-user-api/user-1.md) | <p>Recupera as informações de perfil do usuário conectado, incluindo:<br>-ID de usuário, e-mail, nome, sobrenome e<br>-Convites de equipe pendentes com detalhes do remetente.<br>Use este endpoint para ver detalhes do usuário conectado atualmente.</p>                                                                   |
| [Retrieve user details](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)        | <p>Recupera informações sobre outros usuários na equipe ou sobre um usuário específico pelo ID de usuário.<br>Requer acesso apropriado (varejista ou administrador) dentro do namespace, e o usuário deve fazer parte da equipe. Este endpoint é usado para o gerenciamento de usuários no nível da equipe.</p>              |
| [Update current user detail](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)   | Modifica o nome, sobrenome e ID do arquivo de logotipo do usuário conectado. Este endpoint não suporta a atualização de detalhes de outros usuários.                                                                                                                                                                         |
| [Remove a user](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)                | Remove um usuário de uma equipe (requer permissões apropriadas).                                                                                                                                                                                                                                                             |
| [Modify user permission](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)       | <p>Atualiza as permissões do usuário por ID de usuário e ID de equipe.<br>Tipos de permissão\*\*:<br>-Varejista (Acesso completo ou Visualizador de relatórios)<br>-Fornecedor (Acesso completo ou Visualizador de relatórios).<br><strong>Nota</strong>: As funções de varejista e fornecedor não podem ser combinadas.</p> |
| [Upload a file](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)                | Faz o upload de logotipos para perfis de usuário e equipes.                                                                                                                                                                                                                                                                  |
| [Retrieve file URL](/retail-media-interface/partner/pt-br/team-user-api/user-1.md)            | <p>Gera uma URL de download temporária para arquivos carregados usando o ID do arquivo.<br><strong>Nota</strong>: As URLs são válidas por apenas 3600 segundos.</p>                                                                                                                                                          |

Para perguntas frequentes e dicas de solução de problemas, consulte [Perguntas frequentes](/retail-media-interface/partner/pt-br/partner-api-overview/frequently-asked-questions.md#team-and-user).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/partner/pt-br/team-user-api/user-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
