ListGroups
Obtém a lista de todos os grupos.
Payload de entrada:
{
"O valor a ser pesquisado no nome do grupo"
searchValue: "string",
"Tenant que deseja buscar os grupos, deixar em branco caso não esteja executando a partir do tenant Master (senior)"
tenant: "string",
"As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados."
pagination: {
"O número da página retornado. A primeira página corresponde ao índice 0"
pageNumber: 0,
"Quantidade de registros por página"
pageSize: 10
}
}
"O valor a ser pesquisado no nome do grupo"
searchValue: "string",
"Tenant que deseja buscar os grupos, deixar em branco caso não esteja executando a partir do tenant Master (senior)"
tenant: "string",
"As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados."
pagination: {
"O número da página retornado. A primeira página corresponde ao índice 0"
pageNumber: 0,
"Quantidade de registros por página"
pageSize: 10
}
}
Request
curl --location --request POST "https://api.senior.com.br/platform/user/queries/listGroups" --header "Content-Type: application/json" --header "Accept: application/json" --header "Authorization: Bearer {token}" --data-raw "{'searchValue': {string}, 'tenant': {string}, 'pagination': {'description': {string}, 'pageNumber': {integer}, 'pageSize': {integer}}}"
Response
- 200 Ok
{
"groups": [
{
"id": "string",
"name": "string",
"description": "string",
"email": "string"
}
],
"listInformation": {
"totalElements": 0,
"totalPages": 0
}
}
"groups": [
{
"id": "string",
"name": "string",
"description": "string",
"email": "string"
}
],
"listInformation": {
"totalElements": 0,
"totalPages": 0
}
}
- 403 Permissão negada