Skip to content

Membros e Papéis ​

Este endpoint gerencia os membros de uma organização e seus respectivos papéis (permissões). Apenas usuários com papel de owner ou admin podem adicionar, editar ou remover outros membros.

Objeto Membro ​

AtributoTipoDescrição
idstringO ID único do registro de papel (UUID).
user_idstringO ID do usuário que é membro.
rolestringO papel do usuário na organização (owner, admin, member, guest).
profilesobjectUm objeto com informações do perfil do usuário (username, email, avatar_url).

Listar Membros de uma Organização ​

Retorna uma lista de todos os usuários que são membros de uma organização específica.

GET/api/user-organization-roles

Parâmetros de Query ​

ParâmetroTipoDescrição
organization_idstringObrigatório. O ID da organização cujos membros você deseja listar.

Resposta ​

Retorna um array de objetos de Membro.

Códigos de Status HTTP ​

  • 200 OK: Membros listados com sucesso.
  • 400 Bad Request: Parâmetro organization_id ausente ou inválido.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 500 Internal Server Error: Erro interno do servidor ao listar os membros.

Adicionar um Membro ​

Adiciona um novo usuário a uma organização com um papel específico.

POST/api/user-organization-roles

Parâmetros de Query ​

ParâmetroTipoDescrição
organization_idstringObrigatório. O ID da organização onde o membro será adicionado.

Corpo da Requisição ​

json
{
  "user_id": "u1v2w3x4-y5z6-7890-1234-567890abcdef",
  "role": "member"
}

Resposta ​

201 Created com uma mensagem de sucesso.

Códigos de Status HTTP ​

  • 201 Created: Membro adicionado com sucesso.
  • 400 Bad Request: Dados da requisição inválidos (ex: user_id ou role ausente/inválido).
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 403 Forbidden: Usuário não tem permissão para adicionar membros.
  • 404 Not Found: Organização ou usuário não encontrado.
  • 409 Conflict: O usuário já é membro da organização.
  • 500 Internal Server Error: Erro interno do servidor ao adicionar o membro.

Atualizar o Papel de um Membro ​

Altera o papel de um membro existente em uma organização.

PUT/api/user-organization-roles

Parâmetros de Query ​

ParâmetroTipoDescrição
organization_idstringObrigatório. O ID da organização.
member_idstringObrigatório. O ID do registro de papel (user_organization_roles.id) a ser atualizado.

Corpo da Requisição ​

json
{
  "role": "admin"
}

Resposta ​

Retorna o objeto de Membro atualizado.

Códigos de Status HTTP ​

  • 200 OK: Papel do membro atualizado com sucesso.
  • 400 Bad Request: Dados da requisição inválidos (ex: role ausente/inválido).
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 403 Forbidden: Usuário não tem permissão para atualizar o papel.
  • 404 Not Found: Registro de papel não encontrado.
  • 500 Internal Server Error: Erro interno do servidor ao atualizar o papel do membro.

Remover um Membro ​

Remove um usuário de uma organização.

DELETE/api/user-organization-roles

Parâmetros de Query ​

ParâmetroTipoDescrição
organization_idstringObrigatório. O ID da organização.
member_idstringObrigatório. O ID do registro de papel (user_organization_roles.id) a ser removido.

Resposta ​

204 No Content em caso de sucesso.

Códigos de Status HTTP ​

  • 204 No Content: Membro removido com sucesso.
  • 401 Unauthorized: Autenticação necessária ou credenciais inválidas.
  • 403 Forbidden: Usuário não tem permissão para remover o membro.
  • 404 Not Found: Registro de papel não encontrado.
  • 500 Internal Server Error: Erro interno do servidor ao remover o membro.