ApiDoc Global API

AuthController extends Controller

Table of Contents

Methods

actionCheckExistingUser()  : array{name: string, message: string, code: int, status: int, data: bool}
Desc: Comprueba la existencia de un usuario. Funciona con método GET.
actionGetRoles()  : array{name: string, message: string, code: int, status: int, data: mixed}
Desc: Obtiene los roles del usuario. Funciona con método GET.
actionLoginAdmin()  : UserRest|null, token: mixed}}
Desc: Valida los datos de inicio de sesión y retorna los datos necesarios para autenticado. Funciona con método POST.
behaviors()  : array<string|int, mixed>
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
init()  : void
Desc: Inicializa configuraciones para el controlador.

Methods

actionCheckExistingUser()

Desc: Comprueba la existencia de un usuario. Funciona con método GET.

public actionCheckExistingUser(string $username) : array{name: string, message: string, code: int, status: int, data: bool}

Notes: n/a,

Ref: LoginFormAdmin

Date: 2026-02-26

Example: n/a

Parameters
$username : string
Return values
array{name: string, message: string, code: int, status: int, data: bool}

actionGetRoles()

Desc: Obtiene los roles del usuario. Funciona con método GET.

public actionGetRoles() : array{name: string, message: string, code: int, status: int, data: mixed}

Notes: n/a,

Ref: UserRest

Date: 2025-08-11, Version: v0.2507.01

Example: n/a

Return values
array{name: string, message: string, code: int, status: int, data: mixed}

actionLoginAdmin()

Desc: Valida los datos de inicio de sesión y retorna los datos necesarios para autenticado. Funciona con método POST.

public actionLoginAdmin() : UserRest|null, token: mixed}}

Notes: n/a,

Ref: LoginFormAdmin

Date: 2026-02-26

Example: n/a

Return values
UserRest|null, token: mixed}}

        
On this page

Search results