Search docs/

Membros por identificador

{...}

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

POST https://api.provedor-registrado.com/v1/@layers:data:Members: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

  • dataLayersDataMembersResponseDatum[ ]obrigatório

  • removeUnlistedUsersBooleanobrigatório

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

Exemplo

{
  "data": [
    {
      "active": true,
      "alias": "exemplo",
      "name": "exemplo",
      "birth": "2021-05-07",
      "fields": {},
      "users": [
        "exemplo"
      ]
    }
  ],
  "removeUnlistedUsers": true
}
CopiarCopiado