Receba novidades do Hedhog no seu e-mail

Novos lançamentos, receitas e breaking changes — sem spam.

Voltar para os módulos CoreIntegrado no CoreModule

Submódulo Core

profile

Detém o perfil do usuário atual, MFA, códigos de recuperação e configurações pessoais.

Caminho de origem: libraries/core/src/profile

Arquivo do módulo: profile.module.ts

Introdução

Esta página documenta o submódulo profile como parte do pacote Core. Use-a como referência técnica rápida para escopo de implementação, APIs expostas e pontos de integração MCP.

Endpoints HTTP

30 endpoints

Retorna o perfil do usuário atualmente autenticado.

Atualiza as informações de perfil do usuário atual.

Body

Field	Type	Required	Notes
name	string	yes	—

Faz upload de um novo avatar para o usuário atual.

Body

Field	Type	Required	Notes
file	File	yes	Image file, multipart/form-data

Atualiza as preferências de interface do usuário atual.

Body

Field	Type	Required	Notes
theme	"light" \| "dark" \| "system"	no	—
language	string	no	2-char language code

Altera a senha do usuário atual.

Body

Field	Type	Required	Notes
currentPassword	string	yes	Strong password
newPassword	string	yes	Min 6 chars

Inicia a alteração de e-mail; dispara um fluxo de verificação.

Body

Field	Type	Required	Notes
password	string	yes	Min 6 chars (current password)
email	string	yes	New email address
pin	string	no	Pin code (if MFA is required)

Lista todos os métodos de MFA registrados para o usuário atual.

Retorna o identificador de e-mail principal do usuário atual.

Renomeia um método de MFA.

Params: mfaId (int)

Body

Field	Type	Required	Notes
name	string	yes	—

Verifica se o usuário precisa concluir a verificação de MFA antes de adicionar um novo método.

Verifica se o usuário precisa concluir a verificação de MFA antes de remover um método.

Verifica o método de MFA atual antes de adicionar um novo.

Body

Field	Type	Required	Notes
verificationCode	string	yes	—
verificationType	"totp" \| "email" \| "recovery" \| "webauthn"	yes	—
hash	string	no	—
assertionResponse	object	no	WebAuthn assertion (if verificationType is webauthn)

Gera um secret TOTP e uma URI de QR code para a configuração do aplicativo autenticador.

Verifica um token TOTP e salva o aplicativo autenticador como um método de MFA.

Body

Field	Type	Required	Notes
name	string	yes	—
token	string	yes	Exactly 6 digits
secret	string	yes	TOTP secret from generate step

Remove o método de MFA por TOTP após verificar o token atual.

Params: mfaId (int)

Body

Field	Type	Required	Notes
token	string	yes	Current TOTP code to confirm removal

Envia um código de verificação para o e-mail do usuário.

Body

Field	Type	Required	Notes
email	string	yes	Valid email address

Confirma o código de verificação de e-mail.

Body

Field	Type	Required	Notes
pin	string	yes	Pin code received by email
challengeId	number	yes	—
name	string	no	—

Envia um código de verificação para configurar o e-mail como método de MFA.

Body

Field	Type	Required	Notes
email	string	yes	Valid email address

Confirma o código de verificação da configuração de MFA por e-mail.

Body

Field	Type	Required	Notes
pin	string	yes	Pin code received by email
challengeId	number	yes	—
name	string	no	—

Remove um método de MFA por e-mail.

Params: mfaId (int)

Body

Field	Type	Required	Notes
token	string	yes	—
hash	string	yes	—

Envia um código de confirmação de remoção para o e-mail que está sendo desvinculado.

Body

Field	Type	Required	Notes
email	string	yes	Email address to be unlinked

Envia um desafio de verificação antes de exibir ou regenerar os códigos de recuperação.

Regenera os códigos de recuperação após verificar a identidade.

Body

Field	Type	Required	Notes
verificationCode	string	no	—
hash	string	no	—
verificationType	"totp" \| "email" \| "recovery" \| "webauthn"	no	—
assertionResponse	object	no	—

Remove um método de MFA após concluir a verificação exigida.

Params: mfaId (int)

Body

Field	Type	Required	Notes
token	string	no	—
hash	string	no	—
verificationType	"totp" \| "email" \| "recovery" \| "webauthn"	no	—
assertionResponse	object	no	—

Remove um método de MFA usando um código de recuperação como comprovação de identidade.

Params: mfaId (int)

Body

Field	Type	Required	Notes
recoveryCode	string	yes	—

Gera as opções de registro WebAuthn para adicionar uma passkey.

Body

Field	Type	Required	Notes
name	string	yes	Display name for the passkey

Verifica e salva uma nova credencial WebAuthn.

Body

Field	Type	Required	Notes
name	string	yes	—
attestationResponse	object	yes	WebAuthn attestation from the browser

Gera as opções de autenticação WebAuthn para verificar uma passkey.

Verifica uma asserção de autenticação WebAuthn.

Body

Field	Type	Required	Notes
assertionResponse	object	yes	WebAuthn assertion from the browser

Remove uma passkey WebAuthn registrada.

Params: mfaId (int)

Ferramentas MCP

Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).

core.profile.get
Retorna os dados de perfil do usuário atual
core.profile.update
Atualiza as informações de perfil do usuário atual
core.profile.update-preferences
Atualiza as preferências de exibição e de locale do usuário atual
core.profile.mfa.list
Lista as credenciais de MFA/WebAuthn registradas para o usuário atual
core.profile.change-password
Altera a senha do usuário atual