Referência da API

Usuários

Gerencie usuários no seu projeto. Todos os endpoints requerem uma chave secreta e são exclusivos do lado do servidor.

Somente lado do servidor

Todos os endpoints de gerenciamento de usuários requerem sua sk_live_ chave secreta. Nunca exponha isso no código do lado do cliente.

GET/v1/dashboard/users

Listar Usuários

Liste todos os usuários do projeto atual. Requer chave secreta.

Parâmetros de Query

text

?limit=20&offset=0&search=john&projectId=proj_abc123

Resposta

json

{
  "users": [
    {
      "id": "usr_abc123",
      "email": "user@example.com",
      "displayName": "John Doe",
      "avatarUrl": null,
      "isBanned": false,
      "signInCount": 5,
      "lastSignInAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 42
}

GET/v1/dashboard/users/:userId

Obter Usuário

Obtenha um único usuário por ID com seus provedores vinculados e sessões ativas.

Resposta

json

{
  "id": "usr_abc123",
  "email": "user@example.com",
  "displayName": "John Doe",
  "providers": ["google", "github"],
  "sessions": [...],
  "publicMetadata": {}
}

PATCH/v1/dashboard/users/:userId/ban

Banir Usuário

Bana um usuário. Revoga todas as sessões ativas e impede futuros acessos.

Resposta

json

{ "success": true }

PATCH/v1/dashboard/users/:userId/unban

Desbanir Usuário

Levante o banimento de um usuário, permitindo que ele entre novamente.

Resposta

json

{ "success": true }

DELETE/v1/dashboard/users/:userId

Excluir Usuário

Exclua permanentemente um usuário e todos os seus dados. Esta ação é irreversível.

Resposta

json

{ "success": true }