Create New User

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "username": "johndoe",
  "email": "john@example.com",
  "password": "securepassword123",
  "role": "user",
  "license": "Growth",
  "setupCompleted": false,
  "authType": "basic"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/users"

payload = {
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "password": "securepassword123",
    "role": "user",
    "license": "Growth",
    "setupCompleted": False,
    "authType": "basic"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Doe',
    username: 'johndoe',
    email: 'john@example.com',
    password: 'securepassword123',
    role: 'user',
    license: 'Growth',
    setupCompleted: false,
    authType: 'basic'
  })
};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "User created successfully",
  "user": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1,
    "isVerified": true,
    "setupCompleted": false,
    "authType": "basic",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

POST

users

Create New User

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "username": "johndoe",
  "email": "john@example.com",
  "password": "securepassword123",
  "role": "user",
  "license": "Growth",
  "setupCompleted": false,
  "authType": "basic"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/users"

payload = {
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "password": "securepassword123",
    "role": "user",
    "license": "Growth",
    "setupCompleted": False,
    "authType": "basic"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Doe',
    username: 'johndoe',
    email: 'john@example.com',
    password: 'securepassword123',
    role: 'user',
    license: 'Growth',
    setupCompleted: false,
    authType: 'basic'
  })
};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "User created successfully",
  "user": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1,
    "isVerified": true,
    "setupCompleted": false,
    "authType": "basic",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

Criar novo usuário

Crie uma nova conta de usuário. Acessível apenas por administradores.

Ponto final

POST /users

Descrição

Este endpoint permite que os administradores criem novas contas de usuário no sistema. Você pode especificar vários atributos de usuário, incluindo função, licença e tipo de autenticação. Este é um endpoint administrativo que requer permissões apropriadas.

Fluxo de criação de usuário

Autenticação Básica (authType: "basic"): O usuário recebe um e-mail de boas-vindas com um link de configuração de senha. A conta é criada sem ser verificada até que a senha seja definida. Empresa SSO (authType: "enterprise"): o usuário é criado e verificado e pode entrar por meio da empresa SSO (Auth0, Microsoft AD, etc.). Nenhuma configuração de senha é necessária.

Autenticação

Obrigatório. Inclua sua chave de API no cabeçalho de autorização.

Authorization: Bearer sk-your-api-key-here

Solicitação

Corpo da solicitação

Parâmetro	Tipo	Obrigatório	Padrão	Descrição
`name`	corda	Sim	-	Nome completo do usuário
`username`	corda	Não	-	Nome de usuário exclusivo (gerado automaticamente a partir de e-mail, se não for fornecido)
`email`	corda	Sim	-	Endereço de e-mail do usuário
`role`	corda	Não	usuário	Função do usuário (admin, usuário, globalReader)
`license`	corda	Não	Essencial	Nível de licença do usuário (Essential, Growth, Ultra, Early Access)
`roleId`	corda	Não	-	ID de função personalizada (MongoDB ObjectId)
`setupCompleted`	booleano	Não	falso	Se a configuração do usuário foi concluída
`authType`	corda	Não	básico	Tipo de autenticação (básica, empresarial)

Exemplo de solicitação

curl -X POST "https://{customer.name}.hiperai.ai/api/external/users" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "setupCompleted": false,
    "authType": "enterprise"
  }'

Resposta

Resposta de sucesso (201)

{
  "success": true,
  "message": "User created successfully",
  "user": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth",
    "status": 1,
    "isVerified": false,
    "setupCompleted": false,
    "authType": "basic",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}

Campos de resposta

Campo	Tipo	Descrição
`success`	booleano	Sempre `true` para solicitações bem-sucedidas
`message`	corda	Mensagem de sucesso
`user`	objeto	Objeto de usuário criado
`user.id`	corda	Identificador único do utilizador
`user.name`	corda	Nome completo do usuário
`user.username`	corda	Nome de usuário do usuário
`user.email`	corda	Endereço de e-mail do usuário
`user.role`	corda	Função do usuário
`user.license`	corda	Nível de licença do usuário
`user.status`	inteiro	Status do usuário (1=ativo)
`user.isVerified`	booleano	Se o usuário foi verificado
`user.setupCompleted`	booleano	Se a configuração do usuário foi concluída
`user.authType`	corda	Tipo de autenticação
`user.createdAt`	corda	Carimbo de data e hora de criação do usuário

Exemplo de uso

JavaScript

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/users', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'John Doe',
    username: 'johndoe',
    email: 'john@example.com',
    role: 'user',
    license: 'Growth'
  })
});

const data = await response.json();

if (data.success) {
  console.log('User created:', data.user.name);
  console.log('User ID:', data.user.id);
}

###Píton

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
}

data = {
    'name': 'John Doe',
    'username': 'johndoe',
    'email': 'john@example.com',
    'role': 'user',
    'license': 'Growth'
}

response = requests.post('https://{customer.name}.hiperai.ai/api/external/users', 
                       headers=headers, json=data)
result = response.json()

if result['success']:
    print('User created:', result['user']['name'])
    print('User ID:', result['user']['id'])

###cURL

curl -X POST "https://{customer.name}.hiperai.ai/api/external/users" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "username": "johndoe",
    "email": "john@example.com",
    "role": "user",
    "license": "Growth"
  }'

Respostas de erro

400 Solicitação incorreta

{
  "success": false,
  "error": "Invalid request parameters",
  "message": "The 'name' field is required"
}

400 Tipo de autenticação inválido

{
  "success": false,
  "error": "Invalid authType",
  "message": "authType must be either \"basic\" or \"enterprise\""
}

400 campos obrigatórios ausentes

{
  "success": false,
  "error": "Missing required fields",
  "message": "Name and email are required"
}

401 Não autorizado

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

403 Proibido

{
  "success": false,
  "error": "Access denied",
  "message": "Admin access required"
}

409 Conflito

{
  "success": false,
  "error": "User already exists",
  "message": "A user with this email already exists"
}

Validações e regras de negócios

Valor da licença: Deve ser uma das licenças permitidas (Essential, Growth, Ultra, Early Access). Valores inválidos retornam 400.
Capacidade da licença: Aplicada via checkLicenseCapacity. Se a capacidade estiver cheia para o nível selecionado, retornará 400.
Normalização de e-mail: letras minúsculas e cortadas antes da validação e armazenamento.
Normalização de nome de usuário: letras minúsculas e cortadas antes da validação e armazenamento. Gerado automaticamente a partir de e-mail, se não for fornecido.
Formato de email: Validado com um regex simples; e-mails inválidos retornam 400.
Formato do nome de usuário: Deve corresponder a ^[a-z0-9.-]{3,30}$; nomes de usuário inválidos retornam 400.
Singularidade: email, username e name devem ser exclusivos. Os conflitos retornam 409.
Comportamento de convite por e-mail: para autenticação básica, os usuários recebem e-mails de boas-vindas com links de configuração de senha.

Normalização e armazenamento

email e username são sempre armazenados em letras minúsculas e aparados.

Formas de erro típicas

400 Licença Inválida

{
  "success": false,
  "error": "Invalid license",
  "message": "License must be one of: Essential, Growth, Ultra, Early Access"
}

400 Licença indisponível

{
  "success": false,
  "error": "License unavailable",
  "message": "No Growth licenses available (used/limit)"
}

400 E-mail inválido

{
  "success": false,
  "error": "Invalid email",
  "message": "Email format is invalid"
}

400 Nome de usuário inválido

{
  "success": false,
  "error": "Invalid username",
  "message": "Username must be 3-30 chars, lowercase letters, digits, \".\", "-", or \"\""
}

409 Conflito (Singularidade)

{
  "success": false,
  "error": "Email/Username/Name already exists",
  "message": "A user with this email already exists"
}

Funções do usuário

Função	Descrição	Permissões
`admin`	Administrador	Acesso total ao sistema
`user`	Usuário regular	Acesso de usuário padrão
`globalReader`	Leitor Global	Acesso somente leitura ao painel de administração

Níveis de licença

Licença	Descrição	Recursos
`Essential`	Camada básica	Recursos limitados
`Growth`	Nível profissional	Recursos aprimorados
`Ultra`	Nível premium	Recursos completos
`Early Access`	Nível de acesso antecipado	Recursos beta

Tipos de autenticação

Tipo	Descrição
`basic`	Autenticação de nome de usuário/senha (usuário recebe e-mail de configuração de senha)
`enterprise`	Integração empresarial SSO (Auth0, Microsoft AD, etc.)

Casos de uso

User Onboarding: crie novas contas de usuário para membros da equipe
Onboarding sem senha: crie usuários que recebem convites por e-mail para definir suas próprias senhas
SSO Integração: Crie usuários que se autenticam por meio de provedores de identidade externos
Criação de usuários em massa: crie vários usuários programaticamente
Integração: Crie usuários de sistemas externos
Tarefas administrativas: Gerenciar contas de usuários por meio de API

Limites de taxa

Este endpoint segue os limites de taxa padrão:

60 solicitações por minuto
1000 solicitações por hora

Autorizações

Authorization

string

header

obrigatório

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Corpo

application/json

name

string

obrigatório

User's full name

Exemplo:

"John Doe"

username

string

obrigatório

Unique username

Exemplo:

"johndoe"

string<email>

obrigatório

User's email address

Exemplo:

"john@example.com"

password

string

obrigatório

User's password

Exemplo:

"securepassword123"

role

enum<string>

padrão:user

User's role

Opções disponíveis:

admin,

user,

globalReader

Exemplo:

"user"

license

enum<string>

padrão:Essential

User's license tier

Opções disponíveis:

Essential,

Growth,

Ultra,

Early Access

Exemplo:

"Growth"

roleId

string

Custom role ID (MongoDB ObjectId)

Exemplo:

"60a7c8f5e8b4f5001f7a8c24"

setupCompleted

boolean

padrão:false

Whether user setup is completed

Exemplo:

false

authType

enum<string>

padrão:basic

Authentication type

Opções disponíveis:

basic,

auth0

Exemplo:

"basic"

Resposta

User created successfully

success

boolean

Exemplo:

true

message

string

Exemplo:

"User created successfully"

user

object

Show child attributes

​Criar novo usuário

​Ponto final

​Descrição

​Fluxo de criação de usuário

​Autenticação

​Solicitação

​Corpo da solicitação

​Exemplo de solicitação

​Resposta

​Resposta de sucesso (201)

​Campos de resposta

​Exemplo de uso

​JavaScript

​Respostas de erro

​400 Solicitação incorreta

​400 Tipo de autenticação inválido

​400 campos obrigatórios ausentes

​401 Não autorizado

​403 Proibido

​409 Conflito

​Validações e regras de negócios

​Normalização e armazenamento

​Formas de erro típicas

​400 Licença Inválida

​400 Licença indisponível

​400 E-mail inválido

​400 Nome de usuário inválido

​409 Conflito (Singularidade)

​Funções do usuário

​Níveis de licença

​Tipos de autenticação

​Casos de uso

​Limites de taxa

Autorizações

Corpo

Resposta

Criar novo usuário

Ponto final

Descrição

Fluxo de criação de usuário

Autenticação

Solicitação

Corpo da solicitação

Exemplo de solicitação

Resposta

Resposta de sucesso (201)

Campos de resposta

Exemplo de uso

JavaScript

Respostas de erro

400 Solicitação incorreta

400 Tipo de autenticação inválido

400 campos obrigatórios ausentes

401 Não autorizado

403 Proibido

409 Conflito

Validações e regras de negócios

Normalização e armazenamento

Formas de erro típicas

400 Licença Inválida

400 Licença indisponível

400 E-mail inválido

400 Nome de usuário inválido

409 Conflito (Singularidade)

Funções do usuário

Níveis de licença

Tipos de autenticação

Casos de uso

Limites de taxa