Enspace
  1. Membros
Enspace
  • Introdução
  • Autenticação
  • Conceitos
  • Primeiros Passos
  • Workspaces
    • Categorias
      • Campos
        • Listar campos
        • Criar campo
        • Obter campo específico
        • Atualizar campo
        • Excluir campo
      • Items
        • Listar items
        • Criar novo item
        • Contar items
        • Obter item específico
        • Atualizar item
        • Remover item
      • Listar categorias
      • Contar categorias
      • Obter categoria específica
      • Criar categoria
      • Atualizar categoria
      • Excluir categoria
    • Membros
      • Listar membros
        GET
      • Contar membros
        GET
      • Obter membro
        GET
      • Novo membro
        POST
      • Atualizar membro
        PUT
      • Remover membro
        DELETE
    • Cargos
      • Listar cargos
      • Criar cargo
      • Obter cargo específica
      • Contar cargos
      • Atualizar cargo
      • Excluir cargo
      • Listar Permissões da Role
      • Adicionar Permissão à Role
      • Remover Permissão da Role
    • Grupos de Membros
      • Listar grupos
      • Novo grupo
      • Obter grupo
      • Atualizar grupo
      • Excluir grupo
    • Listar Workspaces
      GET
    • Contexto do Workspace
      GET
    • Novo Workspace
      POST
    • Sair do workspace
      POST
    • Estatísticas do Workspace
      GET
    • Prévia de Exclusão do Workspace
      GET
    • Excluir Workspace
      DELETE
  • Usuário
    • Logs de Auditoria
      GET
    • Listar Chaves de API
      GET
  1. Membros

Novo membro

Em teste
Develop Env
https://api-develop.enspace.io
Develop Env
https://api-develop.enspace.io
POST
https://api-develop.enspace.io
/ws/members
Responsável:Não configurado

Adicionar Membro ao Workspace#

Adiciona um novo usuário como membro do workspace atual.

Corpo da Requisição#

CampoTipoObrigatórioDescrição
emailstringSimE-mail do usuário a ser adicionado
typestringSimTipo de membro: full, standard ou viewer
rolenumberNãoID do papel/cargo
mgroupsarrayNãoIDs dos grupos aos quais o membro será vinculado (depreciado)
fnamestringNãoPrimeiro nome do usuário a ser adicionado
lnamestringNãoUltimo nome do usuário a ser adicionado
v1_compatibilitybooleanNãoAtiva compatibilidade com Interface v1

Validações de Tipo#

owner: Apenas 1 permitido por workspace
viewer: (apenas visualização)

Modo Compatibilidade v1#

Quando v1_compatibility=true:
✅ Tipos permitidos: full, standard
❌ Tipos bloqueados: owner, viewer
🔓 Member full terá acesso total (ignora role)
📋 Member standard será limitado apenas por grupos

Exemplo de Requisição#

{
  "email": "novo.usuario@empresa.com",
  "type": "standard"
}

Resposta#

Retorna o objeto do membro criado com status 201.

Comportamentos Especiais#

Se o usuário não existir no sistema, será criado automaticamente
O usuário receberá um e-mail de convite para o workspace
Se já for membro, retorna erro 409 (conflito)

Códigos de Erro#

400 - Dados inválidos ou tipo não permitido em modo v1
403 - Sem permissão para adicionar membros
409 - Usuário já é membro ou limite de owners excedido
422 - Role inválido ou grupos não existentes
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-develop.enspace.io/ws/members' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--header 'en-workspace;' \
--data-raw '{
    "email": "rafaela.franco@bol.com.br",
    "fname": "Rafaela",
    "lname": "Franco",
    "type": "full"
}'
Response Response Example
200 - Success
{
    "email": "juca@homail.com",
    "type": "full",
    "mgroups": [
        300
    ],
    "role": 3
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
API Key
Adicionar parâmetro em header
en-workspace
Exemplo:
en-workspace: ********************
or
Parâmetros Bodyapplication/json
email
string 
requerido
Email do usuário
fname
string 
opcional
Primeiro nome do usuário
lname
string 
opcional
Ultímo nome do usuário
type
enum<string> 
requerido
Tipo de membro no workspace
Valores permitidos:
fullstandardviewer
role
integer 
opcional
ID de um cargo no workspace
>= 1
mgroups
array[integer]
opcional
Por facilitade, é possivel enviar um array com IDs de Grupos de membros em que o usuário será adicionado.
v1_compatibility
boolean 
opcional
Envie, para compatibilidade com usuários acessando frontend v1.x.x
Examples

Respostas

🟢200OK
application/json
Membro adicionado com sucesso
Body
id
integer 
requerido
ID do do registro
created_at
string 
requerido
Data em que o registro foi criado
updated_at
string 
requerido
Data da ultima atualizacao no registro
user
requerido
Usuário vinculado ao membro.
One of
id
integer 
requerido
ID do do registro
created_at
string 
requerido
Data em que o registro foi criado
email
string 
requerido
Email do Usuário
meta
object 
opcional
email
string 
requerido
Email do usuário (usado no cadastro)
type
enum<string> 
requerido
Tipo de membro no workspace
Valores permitidos:
ownerfullstandardviewer
role
opcional
ID de um cargo no workspace
One of
ID da Role relacionada ao membro.
status
enum<string> 
opcional
Status do membro
Valores permitidos:
activependingblocked
🟠400Pedido inválido
🟠401Não autorizado
🟠409409
Página anterior
Obter membro
Próxima página
Atualizar membro
Built with