GPIC - Backend  1.0
Aplicações .NET para o backend do GPIC
Referência à classe WebAPI.Controllers.AuthController

Controller de Autenticação. Mais...

Diagrama de heranças da classe WebAPI.Controllers.AuthController
[legenda]
Diagrama de colaboração para WebAPI.Controllers.AuthController:
[legenda]

Membros públicos

 AuthController (IConfirmEmail confirmEmail, IForgotPassword forgotPassword, ILogin login, IResetPassword resetPassword, ILogger< AuthController > logger)
 Construtor do Controller de Autenticação. Mais...
 
async Task< ActionResult< string > > ConfirmEmail (string? email, string? token)
 Realiza a confirmação do e-mail do usuário através do token de validação fornecido e do E-mail do usuário. Mais...
 
async Task< ActionResult< string > > ForgotPassword (string? email)
 Realiza a solicitação de reset de senha para o e-mail informado. Após a solicitação, um código é enviado para o e-mail do usuário. Mais...
 
async Task< ActionResult< UserLoginOutput > > Login ([FromBody] UserLoginInput request)
 Realiza o login do usário. Mais...
 
async Task< ActionResult< string > > ResetPassword ([FromBody] UserResetPasswordInput request)
 Realiza a alteração de senha do usário. Mais...
 

Descrição detalhada

Controller de Autenticação.

Documentação dos Construtores & Destrutor

◆ AuthController()

WebAPI.Controllers.AuthController.AuthController ( IConfirmEmail  confirmEmail,
IForgotPassword  forgotPassword,
ILogin  login,
IResetPassword  resetPassword,
ILogger< AuthController logger 
)
inline

Construtor do Controller de Autenticação.

Parâmetros
confirmEmailServiço de confirmação de e-mail.
forgotPasswordServiço de solicitação de reset de senha.
loginServiço de login.
resetPasswordServiço de reset de senha.
loggerServiço de log.

Documentação dos métodos

◆ ConfirmEmail()

async Task<ActionResult<string> > WebAPI.Controllers.AuthController.ConfirmEmail ( string?  email,
string?  token 
)
inline

Realiza a confirmação do e-mail do usuário através do token de validação fornecido e do E-mail do usuário.

Parâmetros
emailE-mail do usuário
tokenToken de validação
Retorna
Resultado da solicitação de validação

<response code="200">E-mail confirmado com sucesso</response> <response code="400">Requisição incorreta.</response>

◆ ForgotPassword()

async Task<ActionResult<string> > WebAPI.Controllers.AuthController.ForgotPassword ( string?  email)
inline

Realiza a solicitação de reset de senha para o e-mail informado. Após a solicitação, um código é enviado para o e-mail do usuário.

Retorna
Resultado da requisição

<response code="200">Solicitação realizada com sucesso</response> <response code="400">Requisição incorreta.</response>

◆ Login()

async Task<ActionResult<UserLoginOutput> > WebAPI.Controllers.AuthController.Login ( [FromBody] UserLoginInput  request)
inline

Realiza o login do usário.

Retorna
Retorna token de acesso

<response code="200">Retorna token de acesso</response> <response code="400">Requisição incorreta.</response>

◆ ResetPassword()

async Task<ActionResult<string> > WebAPI.Controllers.AuthController.ResetPassword ( [FromBody] UserResetPasswordInput  request)
inline

Realiza a alteração de senha do usário.

Retorna
Retorna o status da alteração

<response code="200">Retorna o status da alteração</response> <response code="400">Requisição incorreta.</response>


A documentação para esta classe foi gerada a partir do seguinte ficheiro: