Gerenciar grupos de manutenção da pessoa

Como consultar os grupos de manutenção vinculados à uma pessoa utilizando API?

Para consultar os grupos atribuídos a uma pessoa, siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Como listar os dados de cadastro de todas as pessoas utilizando API do Zeev?.

3. Enviar a Requisição: Utilize o endpoint Gerenciar grupos de manutenção da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev).

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $filter, $select, $orderby e $top.

Listar grupos de manutenção por código da pessoa (Auth)

get

Autorizações

Bearer

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

idinteger · int32Opcional

Identificador do grupo

titlestringOpcional

Título do grupo

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/users/{userid}/groups

HTTPcURLJavaScriptPython

GET /api/2/users/{userid}/groups HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "title": "text"
  }
]

Exemplo de requisição para obter os grupos de uma pessoa utilizando API:

Node.js

let userId = 951;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/groups`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como adicionar um grupo de permissão à uma pessoa utilizando API?

Se você deseja atribuir dois ou mais grupos a uma pessoa, considere utilizar o endpoint de cadastro, especificando a lista de funções com o valor de ifExists igual a update. ver mais em como cadastrar pessoas no Zeev, utilizando API.

Para adicionar um grupo a uma pessoa no Zeev utilizando API, siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Obtenha o groupId: Obtenha o código identificador da função, disponível no Zeev na página Avançado > Grupos de acesso ou através de consultas de API como as que estão disponíveis emGrupos de manutenção;

4. Enviar a Requisição: Utilize o endpoint Gerenciar grupos de manutenção da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Adicionar um grupo de manutenção a uma pessoa (Auth)

post

Autorizações

Bearer

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

groupIdinteger · int32Obrigatório

Código identificador do grupo

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

successbooleanOpcional

Indica se houve sucesso

userIdinteger · int32Opcional

Identificador da pessoa

groupIdinteger · int32Opcional

Identificador do grupo

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

post

/api/2/users/{userid}/groups/{groupid}

HTTPcURLJavaScriptPython

POST /api/2/users/{userid}/groups/{groupid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "userId": 1,
  "groupId": 1
}

Exemplo de requisição para adicionar grupo de permissão a uma pessoa:

Node.js

let userId = 456;
let groupId = 852;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "POST"
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/groups/${groupId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como remover um grupo de manutenção de uma pessoa utilizando API?

Para remover um grupo de acesso de uma pessoa, siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;

3. Obtenha o groupId: Obtenha o código identificador da função, disponível no Zeev na página Avançado > Grupos de acesso ou através de consultas de API como as que estão disponíveis emGrupos de manutenção;

4. Enviar a Requisição: Utilize o endpoint Gerenciar grupos de manutenção da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Excluir um grupo de manutenção de uma pessoa (Auth)

delete

Autorizações

Bearer

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

groupIdinteger · int32Obrigatório

Código identificador do grupo

Respostas

204

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

delete

/api/2/users/{userid}/groups/{groupid}

HTTPcURLJavaScriptPython

DELETE /api/2/users/{userid}/groups/{groupid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo

Exemplo de requisição para remover um grupo de uma pessoa:

Node.js

let userId = 456;
let groupId = 852;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "DELETE",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/groups/${groupId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Como copiar grupos de manutenção de uma pessoa para outra utilizando API?

Para copiar os grupos de acesso de uma pessoa para outra utilizando API siga os passos abaixo:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Obter os parâmetros: O parâmetro userid é o código identificador da pessoa de quem se deseja copiar as funções o newuserid é o código identificador da pessoa a quem se deseja atribuir as funções. Ambos podem ser obtidos na página do Zeev Acesso > Pessoas, ou através de consultas de API como nos exemplos disponíveis em Listar pessoas;

3. Enviar a Requisição: Utilize o endpoint Gerenciar grupos de manutenção da pessoa para enviar a requisição conforme modelo e exemplo (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

Copia todos os grupos de manutenção de uma pessoa para outra (Auth)

post

Autorizações

Bearer

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa de origem

newUserIdinteger · int32Obrigatório

Código identificador da pessoa de destino

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

successbooleanOpcional

Indica se houve sucesso

frominteger · int32Opcional

Código da pessoa de quem os grupos foram copiados

tointeger · int32Opcional

Código da pessoa para quem os grupos foram copiados

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

post

/api/2/users/{userid}/groups/copy/{newuserid}

HTTPcURLJavaScriptPython

POST /api/2/users/{userid}/groups/copy/{newuserid} HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "from": 1,
  "to": 1
}

Exemplo de requisição para copiar os grupos de acesso de uma pessoa para outra:

Node.js

let userId = 741;
let newUserId = 963;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "POST",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/groups/copy/${newUserId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

---

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Vincular pessoas a grupos de permissões