ApiDoc BACKEND

CustomAuth extends AuthMethod

Table of Contents

Methods

authenticate()  : IdentityInterface|null
Desc: Método de autenticación personalizado para la API, que verifica la clave API y la firma en las cabeceras de la solicitud.

Methods

authenticate()

Desc: Método de autenticación personalizado para la API, que verifica la clave API y la firma en las cabeceras de la solicitud.

public authenticate(User $user, Request $request, Response $response) : IdentityInterface|null

Notes: El método de autenticación personalizado verifica la presencia de la clave API y la firma en las cabeceras de la solicitud. Luego, busca el cliente de API correspondiente en la base de datos utilizando la clave API. Si se encuentra un cliente activo, se genera una firma esperada utilizando la clave API y el secreto del cliente, y se compara con la firma proporcionada en la solicitud. Si las firmas coinciden, se devuelve la identidad del cliente; de lo contrario, se lanza una excepción de acceso denegado.

Ref: n/a,

Date: 2026-03-18, Version: v0.2603.21,

Example:

 $behaviors['authenticator'] = [
      'class' => CompositeAuth::class,
     'authMethods' => [
        CustomAuth::class,
    ],
   'except' => ['options'],
];
Parameters
$user : User
$request : Request
$response : Response
Return values
IdentityInterface|null

        
On this page

Search results