Search docs/

Grupos por identificador

{...}

Prover os grupos da comunidade de acordo com o período letivo que possuem os identificadores únicos especificados.

POST https://api.provedor-registrado.com/v1/@layers:data:Groups:getByAliases
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2021-05-07T21:29:10.050Z",
    "action": "@layers:identificador_da_action",
    "community": "test"
  },
  "secret": "exemplo",
  "data": {
    "syncProfileId": "5bb2575199d7179dfe85be02",
    "syncRunId": "5bb2575199d7179dfe85be02",
    "season": "2021",
    "aliases": [
      "alias1"
    ]
  }
}
CopiarCopiado

Resposta

Especificação

  • dataLayersDataGroupsResponseDatum[ ]obrigatório

  • removeUnlistedTagsBooleanobrigatório

    Indica se os marcadores não listados nos grupos devem ser desvinculados

  • removeUnlistedComponentsBooleanobrigatório

    Indica se os componentes não listados nos grupos devem ser desvinculados

  • removeUnlistedAdminsBooleanobrigatório

    Indica se os administradores não listados nos grupos devem ser desvinculados

  • removeUnlistedEnrollmentsBooleanobrigatório

    Indica se os membros ou usuários não listados nos grupos devem ser desvinculados

Exemplo

{
  "data": [
    {
      "active": true,
      "alias": "exemplo",
      "name": "exemplo",
      "fields": {},
      "tags": [
        "exemplo"
      ],
      "components": [
        "exemplo"
      ],
      "admins": [
        {
          "email": "luke@starwars.com",
          "components": [
            "exemplo"
          ]
        },
        {
          "alias": "exemplo",
          "components": [
            "exemplo"
          ]
        }
      ],
      "enrollments": {
        "users": [
          "exemplo"
        ],
        "members": [
          "exemplo"
        ]
      }
    }
  ],
  "removeUnlistedTags": true,
  "removeUnlistedComponents": true,
  "removeUnlistedAdmins": true,
  "removeUnlistedEnrollments": true
}
CopiarCopiado