Search docs/

Editar administradores

{...}

Adicionar administradores ao grupo especificado

PUT https://api.layers.digital/v1/groups/{groupId}/admins
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão group:write

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • groupId
    (path)
    obrigatório
    Identificador do grupo.

Resposta

Especificação

  • [].idString

    Identificador do documento do usuário

  • [].createdAtString

    Data de criação do usuário em UTC corrigido para o fuso da comunidade

  • [].updatedAtString

    Data da última modificação do usuário em UTC corrido para o fuso da comunidade

  • [].activeBoolean

    Chave que indica se o usuário está ativo (quando o usuário é apagado, essa chave é mudada para false)

  • [].communityString

    Identificador da communidade do usuário

  • [].statusStringACTIVEINVITEDUNSENTENUM

    Status do usuário. Pode ser ativo (ACTIVE), convidado (INVITED) ou não convidado (UNSENT)

  • [].invitationCountNumber

    Numero de convites enviados para o usuário

  • [].emailStringobrigatório

    Email do usuário

  • [].nameStringobrigatório

    Nome do usuário

  • [].rolesString[ ]obrigatório

    Array contendo as permissões do usuário na plataforma

  • [].addressObject

Exemplo

[
  {
    "id": "5bb2575199d7179dfe85be02",
    "createdAt": "2020-01-01T00:00:00.000Z",
    "updatedAt": "2020-01-01T00:00:00.000Z",
    "active": true,
    "community": "test",
    "status": "ACTIVE",
    "invitationCount": 2,
    "email": "exemplo@tenda.digital",
    "name": "Gabriel Raniere",
    "roles": [
      "guardian",
      "professor"
    ],
    "address": {
      "code": "01414-001",
      "state": "SP",
      "city": "São Caetano do Sul",
      "district": "Centro",
      "address": "Rua Pará",
      "number": "79"
    }
  }
]
CopiarCopiado