Configuração provedor
2 funções do TermoPortal para configuração provedor.
// npm install termo_core --save-exact
import * as portal from "termo_core/portal";
// ou: import { portal } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_pelo_id_configuracao_provedor | GET /configuracao_provedor | Mostra a situação do segredo do app gerado no TermoAuth |
atualizar_pelo_id_configuracao_provedor | PATCH /configuracao_provedor | Grava ou limpa o segredo do app gerado no TermoAuth |
buscar_pelo_id_configuracao_provedor
GET/configuracao_provedor Exige credencial
Mostra a situação do segredo do app gerado no TermoAuth
Só um master do TermoAuth (e-mail @termotubos.com.br) lê. Nunca devolve o valor: segredo_do_app_gerado_no_termo_auth traz só configurado e o final mascarado (final_visivel). criptografia_disponivel é falso quando o servidor está sem a GLOBAL_SECRET_CRIPTOGRAFIA; nesse caso o segredo aparece como não configurado.
function buscar_pelo_id_configuracao_provedor(
credencial_de_acesso: CredencialDeAcesso,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.ConfiguracaoProvedor>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_configuracao_provedor } from "termo_core/portal";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_configuracao_provedor(credencial_de_acesso);Argumentos
Nome
Tipo
Retorno: Promise<tipos.ConfiguracaoProvedor> · Rust: Result<tipos::ConfiguracaoProvedor, ErroAoChamarServico> · veja ConfiguracaoProvedor.
atualizar_pelo_id_configuracao_provedor
PATCH/configuracao_provedor Exige credencial
Grava ou limpa o segredo do app gerado no TermoAuth
Só um master do TermoAuth (e-mail @termotubos.com.br) grava. O segredo do app portal-b2b é guardado cifrado (AES-256-GCM com a GLOBAL_SECRET_CRIPTOGRAFIA) e entregue na hora ao termo_core, sem deploy. Campo ausente não muda nada, texto troca o segredo e null (ou texto vazio) limpa. No máximo 2.000 caracteres, sem quebra de linha.
function atualizar_pelo_id_configuracao_provedor(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.ConfiguracaoProvedorAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.ConfiguracaoProvedor>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_configuracao_provedor } from "termo_core/portal";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_configuracao_provedor(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.ConfiguracaoProvedor> · Rust: Result<tipos::ConfiguracaoProvedor, ErroAoChamarServico> · veja ConfiguracaoProvedor.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
ConfiguracaoProvedor
import type { ConfiguracaoProvedor } from "termo_core/portal";
export interface ConfiguracaoProvedor {
atualizado_em: string;
atualizado_por?: string | null;
criptografia_disponivel: boolean;
segredo_do_app_gerado_no_termo_auth: ValorProtegido;
}ConfiguracaoProvedorAtualizar
import type { ConfiguracaoProvedorAtualizar } from "termo_core/portal";
export interface ConfiguracaoProvedorAtualizar {
segredo_do_app_gerado_no_termo_auth?: string | null;
}ValorProtegido
import type { ValorProtegido } from "termo_core/portal";
export interface ValorProtegido {
configurado: boolean;
final_visivel?: string | null;
}