Configuração
2 funções do TermoTracing para configuração.
// npm install termo_core --save-exact
import * as tracing from "termo_core/tracing";
// ou: import { tracing } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_pelo_id_configuracao | GET /configuracao | Busca a configuração do TermoTracing |
atualizar_pelo_id_configuracao | PATCH /configuracao | Atualiza o segredo do app gerado no TermoAuth |
buscar_pelo_id_configuracao
GET/configuracao Exige credencial
Busca a configuração do TermoTracing
Só um master do TermoAuth (os demais recebem 403). A configuração é uma linha única e guarda o segredo do app termo-tracing gerado no TermoAuth, cifrado no banco com AES-256-GCM e a chave derivada de GLOBAL_SECRET_CRIPTOGRAFIA. O valor nunca volta: segredo_do_app_gerado_no_termo_auth traz só configurado e final_visivel (os 4 últimos caracteres, mascarados). Sem a GLOBAL_SECRET_CRIPTOGRAFIA no servidor, criptografia_disponivel vem false e o segredo aparece como não configurado.
function buscar_pelo_id_configuracao(
credencial_de_acesso: CredencialDeAcesso,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_configuracao } from "termo_core/tracing";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_configuracao(credencial_de_acesso);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.
atualizar_pelo_id_configuracao
PATCH/configuracao Exige credencial
Atualiza o segredo do app gerado no TermoAuth
Só um master do TermoAuth (os demais recebem 403). segredo_do_app_gerado_no_termo_auth é obrigatório: uma string troca o segredo (até 2.000 caracteres, sem quebra de linha; espaços nas pontas são removidos) e null ou string vazia limpa. O valor é gravado cifrado e entregue na hora ao termo_core, que o usa para pedir o token de aplicativo no TermoAuth, sem deploy. Campo desconhecido no corpo responde 422.
function atualizar_pelo_id_configuracao(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.ConfiguracaoAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Configuracao>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_configuracao } from "termo_core/tracing";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_configuracao(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Configuracao> · Rust: Result<tipos::Configuracao, ErroAoChamarServico> · veja Configuracao.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
Configuracao
import type { Configuracao } from "termo_core/tracing";
export interface Configuracao {
atualizado_em: string;
atualizado_por?: string | null;
criptografia_disponivel: boolean;
segredo_do_app_gerado_no_termo_auth: ValorProtegido;
}ConfiguracaoAtualizar
import type { ConfiguracaoAtualizar } from "termo_core/tracing";
export interface ConfiguracaoAtualizar {
segredo_do_app_gerado_no_termo_auth?: string | null;
}ValorProtegido
import type { ValorProtegido } from "termo_core/tracing";
export interface ValorProtegido {
configurado: boolean;
final_visivel?: string | null;
}