> ## Documentation Index
> Fetch the complete documentation index at: https://docs.base44.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Módulo Users

> Convide usuários para o aplicativo via base44.users.

<Warning>
  Esta página faz parte de uma habilidade de agente de código IA e é escrita para agentes, não para humanos. Para a documentação legível por humanos da Base44, veja a [documentação para desenvolvedores](/developers).
</Warning>

# Módulo Users

Convide usuários para o aplicativo via `base44.users`.

## Conteúdo

* [Métodos](#methods)
* [Exemplos](#examples) (Convidar Usuário)
* [Funções](#roles)
* [Notas](#notes)

## Métodos

| Método                         | Assinatura     | Descrição                            |
| ------------------------------ | -------------- | ------------------------------------ |
| `inviteUser(user_email, role)` | `Promise<any>` | Convida um usuário para o aplicativo |

## Exemplos

### Convidar usuário

```javascript theme={null}
// Convida um usuário com a função "user"
await base44.users.inviteUser("newuser@example.com", "user");

// Convida um admin
await base44.users.inviteUser("admin@example.com", "admin");
```

### Convidar vários usuários

```javascript theme={null}
const usersToInvite = [
  { email: "user1@example.com", role: "user" },
  { email: "user2@example.com", role: "user" },
  { email: "manager@example.com", role: "admin" }
];

for (const user of usersToInvite) {
  await base44.users.inviteUser(user.email, user.role);
  console.log(`Invited ${user.email} as ${user.role}`);
}
```

## Funções

O parâmetro `role` deve ser um dos seguintes:

| Função    | Descrição                             |
| --------- | ------------------------------------- |
| `"user"`  | Usuário padrão com permissões padrão  |
| `"admin"` | Administrador com permissões elevadas |

**Nota:** Apenas `"user"` e `"admin"` são valores de função válidos. Um erro será gerado se você passar qualquer outro valor.

## Notas

* **Convite por e-mail**: O usuário convidado recebe um e-mail com um link para entrar no aplicativo
* **Tratamento de duplicatas**: Convidar um usuário existente reenviará o convite
* **Também disponível em auth**: `base44.auth.inviteUser()` fornece a mesma funcionalidade
* **Validação de função**: Apenas `"user"` ou `"admin"` são aceitos

```javascript theme={null}
// Estes são equivalentes:
await base44.users.inviteUser("newuser@example.com", "user");
await base44.auth.inviteUser("newuser@example.com", "user");
```

## Definições de tipo

```typescript theme={null}
/** Users module for inviting users to the app. */
interface UsersModule {
  /**
   * Invite a user to the application.
   * @param user_email - User's email address.
   * @param role - User's role ('user' or 'admin').
   * @returns Promise resolving when the invitation is sent.
   * @throws Error if role is not 'user' or 'admin'.
   */
  inviteUser(user_email: string, role: "user" | "admin"): Promise<any>;
}
```

<Note>Esta página foi traduzida usando IA. Para informações mais precisas e atualizadas, consulte a [versão em inglês](/). </Note>