Auth

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

Função	Rota	O que faz
`buscar_paginador_auth`	`GET /auth`	Lista os acessos paginados
`criar_auth`	`POST /auth`	Cadastra um acesso
`buscar_acesso_auth`	`GET /auth/acesso`	Busca o acesso de quem está logado
`buscar_auto_complete_auth`	`GET /auth/autocomplete`	Lista básica de acessos para seleção
`buscar_pelo_filtro_auth`	`GET /auth/filtro`	Busca acessos por filtro
`buscar_pelo_id_auth`	`GET /auth/{id}`	Busca um acesso pelo id
`atualizar_pelo_id_auth`	`PATCH /auth/{id}`	Atualiza um acesso pelo id
`deletar_pelo_id_auth`	`DELETE /auth/{id}`	Exclui um acesso pelo id

`buscar_paginador_auth`

GET/auth Exige credencial

Lista os acessos paginados

Exige a permissão de leitura na área colaboradores. Lista os acessos não excluídos ordenados pelo perfil e depois pelo e-mail, sempre 50 por página: tamanho é ignorado. pagina começa em 1 (padrão 1; valores menores viram 1). total é a quantidade de acessos não excluídos.

function buscar_paginador_auth(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorAuth = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaAuth>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`criar_auth`

POST/auth Exige credencial

Cadastra um acesso

Exige a permissão criar na área colaboradores. Cadastra quem pode entrar no TermoSupport, sem perfil de acesso: o perfil é escolhido depois em PATCH /colaborador/{id}/perfil_acesso. email é obrigatório (até 160 caracteres, formato de e-mail), é gravado em minúsculas e é único entre os acessos não excluídos; para entrar, a pessoa precisa existir no TermoAuth com o mesmo e-mail do domínio @termotubos.com.br. perfil só aceita colaborador.

function criar_auth(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.AuthCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Auth>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { criar_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_acesso_auth`

GET/auth/acesso Exige credencial

Busca o acesso de quem está logado

Livre para qualquer usuário autenticado com cadastro ativo, mesmo sem nenhuma permissão liberada. Devolve o cadastro de quem chamou, o colaborador_id (o colaborador vinculado ao acesso, usado como responsável, autor e destinatário das notificações), o perfil_acesso (nome do perfil de acesso do colaborador, nulo quando ainda não tem perfil) e as permissoes desse perfil por área (aplicativos, colaboradores, projetos e tickets), cada uma com ler, criar, editar e deletar. Um master do TermoAuth recebe todas as permissões e, no primeiro acesso, ganha o cadastro automaticamente. nome vem do TermoAuth e, se estiver vazio, repete o e-mail. É a chamada que o painel faz antes de mostrar qualquer tela.

function buscar_acesso_auth(
  credencial_de_acesso: CredencialDeAcesso,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.AcessoAtual>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_acesso_auth } from "termo_core/support";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_acesso_auth(credencial_de_acesso);

Argumentos

Nome

Tipo

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

`buscar_auto_complete_auth`

GET/auth/autocomplete Exige credencial

Lista básica de acessos para seleção

Exige a permissão de leitura na área colaboradores. Devolve só id, e-mail e perfil, em ordem alfabética do e-mail, sem os excluídos. busca procura o trecho no e-mail, sem diferenciar maiúsculas, e perfil é exato. pagina começa em 1 (padrão 1) e tamanho tem padrão 10, sem máximo; valores menores que 1 viram 1.

function buscar_auto_complete_auth(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteAuth = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaAuthAutoComplete>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_filtro_auth`

GET/auth/filtro Exige credencial

Busca acessos por filtro

Exige a permissão de leitura na área colaboradores. Devolve todos os acessos não excluídos que casam com o filtro, sem paginação, em ordem alfabética do e-mail. email procura o trecho no e-mail, sem diferenciar maiúsculas; perfil é exato; ativo filtra pela situação. Sem filtro, devolve todos.

function buscar_pelo_filtro_auth(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroAuth = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Auth>>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`buscar_pelo_id_auth`

GET/auth/{id} Exige credencial

Busca um acesso pelo id

Exige a permissão de leitura na área colaboradores (qualquer das ações ler, criar, editar ou deletar libera a leitura). nome vem do colaborador vinculado, e vinculado diz se existe um. Acesso excluído não é encontrado.

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

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`atualizar_pelo_id_auth`

PATCH/auth/{id} Exige credencial

Atualiza um acesso pelo id

Exige a permissão editar na área colaboradores. Atualização parcial: só os campos enviados mudam. email segue as regras do cadastro (até 160 caracteres, formato de e-mail, único) e ativo: false bloqueia a entrada da pessoa no TermoSupport. O acesso de um master do TermoAuth não pode ser alterado.

function atualizar_pelo_id_auth(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.AuthAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Auth>

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_auth } from "termo_core/support";

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

Argumentos

Nome

Tipo

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

`deletar_pelo_id_auth`

DELETE/auth/{id} Exige credencial

Exclui um acesso pelo id

Exige a permissão deletar na área colaboradores. A exclusão é lógica: o acesso some das leituras e o e-mail fica livre para um novo cadastro, mas o registro não é apagado e não há como restaurá-lo. Só exclui acesso sem colaborador vinculado, e o acesso de um master do TermoAuth não pode ser excluído.

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

Exemplo

import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_auth } from "termo_core/support";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_auth(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.

AcessoAtual

import type { AcessoAtual } from "termo_core/support";

export interface AcessoAtual {
  colaborador_id?: string | null;
  email: string;
  id: string;
  master: boolean;
  nome: string;
  perfil: string;
  perfil_acesso?: string | null;
  permissoes: Permissoes;
}

Acoes

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

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

import type { Auth } from "termo_core/support";

export interface Auth {
  ativo: boolean;
  atualizado_em: string;
  criado_em: string;
  email: string;
  id: string;
  master: boolean;
  nome?: string | null;
  perfil: string;
  termoauth_id?: string | null;
  ultimo_login_em?: string | null;
  vinculado: boolean;
}

AuthAtualizar

import type { AuthAtualizar } from "termo_core/support";

export interface AuthAtualizar {
  ativo?: boolean | null;
  email?: string | null;
}

AuthCriar

import type { AuthCriar } from "termo_core/support";

export interface AuthCriar {
  email: string;
  perfil: string;
}

PaginaAuth

import type { PaginaAuth } from "termo_core/support";

export interface PaginaAuth {
  itens: Array<PaginaAuthItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaAuthAutoComplete

import type { PaginaAuthAutoComplete } from "termo_core/support";

export interface PaginaAuthAutoComplete {
  itens: Array<PaginaAuthAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaAuthAutoCompleteItensItem

import type { PaginaAuthAutoCompleteItensItem } from "termo_core/support";

export interface PaginaAuthAutoCompleteItensItem {
  email: string;
  id: string;
  perfil: string;
}

PaginaAuthItensItem

import type { PaginaAuthItensItem } from "termo_core/support";

export interface PaginaAuthItensItem {
  ativo: boolean;
  atualizado_em: string;
  criado_em: string;
  email: string;
  id: string;
  master: boolean;
  nome?: string | null;
  perfil: string;
  termoauth_id?: string | null;
  ultimo_login_em?: string | null;
  vinculado: boolean;
}

Permissoes

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

export interface Permissoes {
  aplicativos?: Acoes;
  colaboradores?: Acoes;
  projetos?: Acoes;
  tickets?: Acoes;
}

Auth

buscar_paginador_authCopiar link

criar_authCopiar link

buscar_acesso_authCopiar link

buscar_auto_complete_authCopiar link

buscar_pelo_filtro_authCopiar link

buscar_pelo_id_authCopiar link

atualizar_pelo_id_authCopiar link

deletar_pelo_id_authCopiar link

TiposCopiar link

AcessoAtualCopiar link

AcoesCopiar link

AuthCopiar link

AuthAtualizarCopiar link

AuthCriarCopiar link

PaginaAuthCopiar link

PaginaAuthAutoCompleteCopiar link

PaginaAuthAutoCompleteItensItemCopiar link

PaginaAuthItensItemCopiar link

PermissoesCopiar link

Nesta página

`buscar_paginador_auth`

`criar_auth`

`buscar_acesso_auth`

`buscar_auto_complete_auth`

`buscar_pelo_filtro_auth`

`buscar_pelo_id_auth`

`atualizar_pelo_id_auth`

`deletar_pelo_id_auth`

Tipos

AcessoAtual

Acoes

Auth

AuthAtualizar

AuthCriar

PaginaAuth

PaginaAuthAutoComplete

PaginaAuthAutoCompleteItensItem

PaginaAuthItensItem

Permissoes