Configuração
2 funções do TermoSupport para configuração.
// 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_pelo_id_configuracao | GET /configuracao | Busca a configuração do app |
atualizar_pelo_id_configuracao | PATCH /configuracao | Atualiza o segredo do app |
buscar_pelo_id_configuracao
GET/configuracao Exige credencial
Busca a configuração do app
Só um master do TermoAuth. Devolve a situação do segredo do app gerado no TermoAuth, que o TermoSupport usa para falar com os outros serviços da Termotubos. O valor nunca é devolvido: só configurado e o final mascarado. criptografia_disponivel falso indica que o servidor não consegue ler nem gravar o segredo; nesse caso ele 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/support";
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
Só um master do TermoAuth. Grava o segredo do app gerado no TermoAuth, criptografado, e passa a usá-lo na hora, sem deploy. Campo ausente não muda, texto troca (até 2000 caracteres, sem quebra de linha; espaços nas pontas são removidos) e null ou texto vazio apaga o segredo.
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/support";
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/support";
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/support";
export interface ConfiguracaoAtualizar {
segredo_do_app_gerado_no_termo_auth?: string | null;
}ValorProtegido
import type { ValorProtegido } from "termo_core/support";
export interface ValorProtegido {
configurado: boolean;
final_visivel?: string | null;
}