Organization Membership

Última atualização: 22 de junho de 2026

Organization Membership é um registro que indica a qual Organization uma pessoa pertence e com qual permissão (role). Uma pessoa pode pertencer a várias Organizations, e a permissão pode variar de uma Organization para outra, portanto cada combinação de pessoa, organização e permissão corresponde a uma Organization Membership. Novos membros são adicionados por convite via e-mail (endpoint Convite (criação) abaixo). Ao criar um convite, a pessoa correspondente a esse e-mail se junta à Organization com aquela role.

A lista de Organizations às quais você pertence é consultada por GET /me/organization-memberships. Ao enviar também include=1, os detalhes da Organization referenciada são incluídos na resposta.

Estrutura do recurso

A seguir está a resposta da consulta individual de uma Organization Membership. Em sys (propriedades de sistema) ficam a pessoa (user) e a organização (organization) que esta associação referencia, e como propriedade de corpo há a permissão (role).

{
  "sys": {
    "id": "3trmXRL6dW1QKblBXOc8nXAVz4kPXd",
    "type": "OrganizationMembership",
    "organization": { "sys": { "id": "ilLRJxDp", "type": "Refer", "targetType": "Organization" } },
    "user": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-05-11T10:51:16.841Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "updatedAt": "2026-05-11T10:51:16.841Z",
    "version": 1
  },
  "role": "OWNER"
}

Chaves principais:

  • organization: o Refer<Organization> que aponta para a Organization a que esta associação pertence.
  • user: o Refer<User> que aponta para a pessoa desta associação. Quando a pessoa convidada se junta, esse usuário fica vinculado aqui.
  • role: o nível de permissão que esta pessoa tem na Organization. É um entre OWNER, ADMIN e MEMBER.

Propriedades de sistema (sys) e corpo

Toda Organization Membership guarda as propriedades de sistema comuns no objeto sys. organization, user, createdBy e updatedBy entram no formato Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).

PropriedadeTipoDescrição
idstringIdentificador único do recurso.
typestringTipo do recurso. Para Organization Membership é sempre "OrganizationMembership".
organizationRefer<Organization>A Organization a que esta associação pertence.
userRefer<User>A pessoa desta associação.
createdByRefer<User>Usuário que criou.
createdAtstring (date-time)Momento da criação.
updatedByRefer<User>Usuário que modificou por último.
updatedAtstring (date-time)Momento da última modificação.
versioninteger (≥1)Versão do recurso. Sobe em 1 a cada modificação.

Propriedades de corpo:

PropriedadeTipoDescrição
rolestring (enum)Nível de permissão do membro. Um entre OWNER, ADMIN e MEMBER.

Os três valores de role significam o seguinte.

  • OWNER: o nível de proprietário da Organization.
  • ADMIN: o nível de administrador da Organization.
  • MEMBER: o nível de membro comum da Organization.

Organization Membership é um recurso de configuração que não tem o conceito de publicação. Por isso, diferentemente de Content e Media, sys não tem publish, archive nem status, apenas version. version sobe a cada modificação da associação.

API

A URL base de todos os endpoints abaixo é https://cma.weegloo.com/v1, e é necessário um token Bearer que autentique a CMA no cabeçalho Authorization. A modificação de papel (PUT, PATCH) exige enviar também o cabeçalho X-Weegloo-Version (o sys.version atual do recurso) para o controle de concorrência otimista. O convite (criação) e a exclusão não têm esse cabeçalho.