Skip to main content
PATCH
Actualizar una configuración de executor

Autorizaciones

Authorization
string
header
requerido

Token bearer JWT emitido por el provider de identidad. Envíalo en la cabecera Authorization como Bearer <token>.

Parámetros de ruta

id
string<uuid>
requerido

Identificador único de la configuración de executor.

Cuerpo

application/json

Cuerpo de la solicitud que contiene los detalles actualizados de la configuración de executor.

authentication
object
requerido
baseUrl
string
requerido

URL base del servicio externo.

Maximum string length: 500
Ejemplo:

"https://api.serasa.com.br/v2"

endpoints
object[]
requerido

Lista de endpoints HTTP expuestos por este executor.

Minimum array length: 1
name
string
requerido

Nombre para mostrar de la configuración de executor.

Required string length: 1 - 100
Ejemplo:

"Serasa KYC"

description
string

Descripción legible por humanos de esta configuración de executor.

Maximum string length: 500
Ejemplo:

"Serasa KYC provider for identity validation"

metadata
object

Pares clave-valor personalizados para etiquetado.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos solicitados.

authentication
object
baseUrl
string

URL base del servicio externo.

Ejemplo:

"https://api.serasa.com.br/v2"

createdAt
string<date-time>

Marca de tiempo de cuando se creó la configuración.

Ejemplo:

"2026-03-15T10:00:00Z"

description
string

Descripción legible por humanos.

Ejemplo:

"Serasa identity validation service"

endpoints
object[]

Lista de endpoints HTTP configurados.

id
string<uuid>

Identificador único de la configuración de executor.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

lastTestedAt
string<date-time>

Marca de tiempo de la última vez que la configuración quedó verificada y lista para la activación.

Ejemplo:

"2026-03-16T09:15:00Z"

metadata
object

Metadatos personalizados.

name
string

Nombre para mostrar.

Ejemplo:

"Serasa KYC"

status
string

Estado actual del ciclo de vida: unconfigured, configured, tested, active o disabled.

Ejemplo:

"active"

updatedAt
string<date-time>

Marca de tiempo de la última actualización.

Ejemplo:

"2026-03-16T09:30:00Z"