Perfil acesso

// npm install termo_core --save-exact
import * as webhook from "termo_core/webhook";
// ou: import { webhook } from "termo_core";

Função	Rota	O que faz
`buscar_paginador_perfil_acesso`	`GET /perfil_acesso`	Lista os perfis de acesso com paginação
`criar_perfil_acesso`	`POST /perfil_acesso`	Cria um perfil de acesso
`buscar_auto_complete_perfil_acesso`	`GET /perfil_acesso/autocomplete`	Lista básica de perfis de acesso para seleção
`buscar_pelo_filtro_perfil_acesso`	`GET /perfil_acesso/filtro`	Busca perfis de acesso por filtro
`buscar_pelo_id_perfil_acesso`	`GET /perfil_acesso/{id}`	Busca um perfil de acesso pelo id
`atualizar_pelo_id_perfil_acesso`	`PATCH /perfil_acesso/{id}`	Atualiza um perfil de acesso pelo id
`deletar_pelo_id_perfil_acesso`	`DELETE /perfil_acesso/{id}`	Exclui um perfil de acesso pelo id

`buscar_paginador_perfil_acesso`

GET/perfil_acesso Exige credencial

Lista os perfis de acesso com paginação

Exige qualquer permissão da área colaboradores (qualquer ação liberada na área já libera a leitura). Ordena pelo nome. pagina começa em 1 (padrão 1; valores menores viram 1). A página tem sempre 50 itens: tamanho é aceito, mas ignorado. total conta todos os registros não excluídos.

function buscar_paginador_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorPerfilAcesso = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaPerfilAcesso>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_perfil_acesso(credencial_de_acesso, { pagina: 1 });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaPerfilAcesso> · Rust: Result<tipos::PaginaPerfilAcesso, ErroAoChamarServico> · veja PaginaPerfilAcesso.

`criar_perfil_acesso`

POST/perfil_acesso Exige credencial

Cria um perfil de acesso

Exige a permissão criar da área colaboradores. O perfil de acesso é o conjunto de permissões que o TermoWebhook dá a um colaborador: cada colaborador aponta para um perfil (PATCH /colaborador/{id}/perfil_acesso) e enxerga o que o perfil libera. nome é obrigatório (até 80 caracteres, único sem diferenciar maiúsculas); descricao é opcional (até 200); permissoes traz, para cada área (monitoramento, aplicativos, contratos, assinaturas e colaboradores), as ações ler, criar, editar e deletar (o que não vier fica false). A resposta inclui colaboradores, quantas pessoas usam o perfil. O master do TermoAuth tem tudo liberado sem precisar de perfil.

function criar_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.PerfilAcessoCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PerfilAcesso>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { criar_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_perfil_acesso(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PerfilAcesso> · Rust: Result<tipos::PerfilAcesso, ErroAoChamarServico> · veja PerfilAcesso.

`buscar_auto_complete_perfil_acesso`

GET/perfil_acesso/autocomplete Exige credencial

Lista básica de perfis de acesso para seleção

Exige qualquer permissão da área colaboradores (qualquer ação liberada na área já libera a leitura). Devolve só o id e o nome, em ordem alfabética. busca procura por trecho do nome, sem diferenciar maiúsculas. pagina começa em 1 (padrão 1) e tamanho tem padrão 10, sem máximo; valores menores que 1 viram 1. total conta os registros que casam com a busca.

function buscar_auto_complete_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompletePerfilAcesso = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaPerfilAcessoAutoComplete>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_perfil_acesso(credencial_de_acesso, { busca: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaPerfilAcessoAutoComplete> · Rust: Result<tipos::PaginaPerfilAcessoAutoComplete, ErroAoChamarServico> · veja PaginaPerfilAcessoAutoComplete.

`buscar_pelo_filtro_perfil_acesso`

GET/perfil_acesso/filtro Exige credencial

Busca perfis de acesso por filtro

Exige qualquer permissão da área colaboradores (qualquer ação liberada na área já libera a leitura). Devolve todos os perfis que casam com o filtro, sem paginação, em ordem alfabética de nome. nome procura por trecho, sem diferenciar maiúsculas. Sem filtro, devolve todos (é o que a tela usa para listar e para escolher o perfil de um colaborador).

function buscar_pelo_filtro_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroPerfilAcesso = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.PerfilAcesso>>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_perfil_acesso(credencial_de_acesso, { nome: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.PerfilAcesso>> · Rust: Result<Vec<tipos::PerfilAcesso>, ErroAoChamarServico>

`buscar_pelo_id_perfil_acesso`

GET/perfil_acesso/{id} Exige credencial

Busca um perfil de acesso pelo id

Exige qualquer permissão da área colaboradores (qualquer ação liberada na área já libera a leitura). Perfil excluído responde 404.

function buscar_pelo_id_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PerfilAcesso>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_perfil_acesso(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PerfilAcesso> · Rust: Result<tipos::PerfilAcesso, ErroAoChamarServico> · veja PerfilAcesso.

`atualizar_pelo_id_perfil_acesso`

PATCH/perfil_acesso/{id} Exige credencial

Atualiza um perfil de acesso pelo id

Exige a permissão editar da área colaboradores. Atualização parcial: só os campos enviados mudam. nome segue o limite do cadastro; descricao vazia apaga o valor; permissoes, quando enviado, substitui o conjunto inteiro (o que não vier fica false). Todo colaborador do perfil passa a valer com as novas permissões em até 5 minutos (cache do acesso).

function atualizar_pelo_id_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.PerfilAcessoAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PerfilAcesso>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_perfil_acesso(credencial_de_acesso, id, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PerfilAcesso> · Rust: Result<tipos::PerfilAcesso, ErroAoChamarServico> · veja PerfilAcesso.

`deletar_pelo_id_perfil_acesso`

DELETE/perfil_acesso/{id} Exige credencial

Exclui um perfil de acesso pelo id

Exige a permissão deletar da área colaboradores. A exclusão é lógica e só é aceita quando nenhum colaborador usa o perfil: com gente vinculada responde 409, e é preciso trocar o perfil dessas pessoas antes.

function deletar_pelo_id_perfil_acesso(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_perfil_acesso } from "termo_core/webhook";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_perfil_acesso(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.

Tipos

Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.

Acoes

import type { Acoes } from "termo_core/webhook";

export interface Acoes {
  criar?: boolean;
  deletar?: boolean;
  editar?: boolean;
  ler?: boolean;
}

PaginaPerfilAcesso

import type { PaginaPerfilAcesso } from "termo_core/webhook";

export interface PaginaPerfilAcesso {
  itens: Array<PaginaPerfilAcessoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaPerfilAcessoAutoComplete

import type { PaginaPerfilAcessoAutoComplete } from "termo_core/webhook";

export interface PaginaPerfilAcessoAutoComplete {
  itens: Array<PaginaPerfilAcessoAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaPerfilAcessoAutoCompleteItensItem

import type { PaginaPerfilAcessoAutoCompleteItensItem } from "termo_core/webhook";

export interface PaginaPerfilAcessoAutoCompleteItensItem {
  id: string;
  nome: string;
}

PaginaPerfilAcessoItensItem

import type { PaginaPerfilAcessoItensItem } from "termo_core/webhook";

export interface PaginaPerfilAcessoItensItem {
  atualizado_em: string;
  colaboradores: number;
  criado_em: string;
  descricao?: string | null;
  id: string;
  nome: string;
  permissoes: Permissoes;
}

PerfilAcesso

import type { PerfilAcesso } from "termo_core/webhook";

export interface PerfilAcesso {
  atualizado_em: string;
  colaboradores: number;
  criado_em: string;
  descricao?: string | null;
  id: string;
  nome: string;
  permissoes: Permissoes;
}

PerfilAcessoAtualizar

import type { PerfilAcessoAtualizar } from "termo_core/webhook";

export interface PerfilAcessoAtualizar {
  descricao?: string | null;
  nome?: string | null;
  permissoes?: Permissoes | null;
}

PerfilAcessoCriar

import type { PerfilAcessoCriar } from "termo_core/webhook";

export interface PerfilAcessoCriar {
  descricao?: string | null;
  nome: string;
  permissoes?: Permissoes;
}

Permissoes

import type { Permissoes } from "termo_core/webhook";

export interface Permissoes {
  aplicativos?: Acoes;
  assinaturas?: Acoes;
  colaboradores?: Acoes;
  contratos?: Acoes;
  monitoramento?: Acoes;
}

buscar_paginador_perfil_acessoCopiar link

criar_perfil_acessoCopiar link

buscar_auto_complete_perfil_acessoCopiar link

buscar_pelo_filtro_perfil_acessoCopiar link

buscar_pelo_id_perfil_acessoCopiar link

atualizar_pelo_id_perfil_acessoCopiar link

deletar_pelo_id_perfil_acessoCopiar link

TiposCopiar link

AcoesCopiar link

PaginaPerfilAcessoCopiar link

PaginaPerfilAcessoAutoCompleteCopiar link

PaginaPerfilAcessoAutoCompleteItensItemCopiar link

PaginaPerfilAcessoItensItemCopiar link

PerfilAcessoCopiar link

PerfilAcessoAtualizarCopiar link

PerfilAcessoCriarCopiar link

PermissoesCopiar link

Nesta página

`buscar_paginador_perfil_acesso`

`criar_perfil_acesso`

`buscar_auto_complete_perfil_acesso`

`buscar_pelo_filtro_perfil_acesso`

`buscar_pelo_id_perfil_acesso`

`atualizar_pelo_id_perfil_acesso`

`deletar_pelo_id_perfil_acesso`

Tipos

Acoes

PaginaPerfilAcesso

PaginaPerfilAcessoAutoComplete

PaginaPerfilAcessoAutoCompleteItensItem

PaginaPerfilAcessoItensItem

PerfilAcesso

PerfilAcessoAtualizar

PerfilAcessoCriar

Permissoes