Listar Información de Tokens

Visión General

Este endpoint recupera una lista paginada de todos los tokens OAuth emitidos para la entidad. Incluye metadatos como roles, alcances (scopes), tiempos de expiración y fechas de creación. Es útil para auditorías, monitoreo de sesiones activas y gestión del ciclo de vida de los tokens.

Detalles del Endpoint

Parámetro

Descripción

Endpoint

https://api.paas.sandbox.co.passportfintech.com/v1/iam/oauth/tokens

Método

GET

Encabezados

Accept-Language, Content-Length, Content-Type: application/json, Authorization

Autenticación

Token de Acceso (Bearer Token)

Parámetros de Consulta

Parámetros de Paginación

Parámetro

Descripción

page_params.page_size

Cantidad de registros a retornar por página.

page_params.page_number

Número de página a consultar.

page_params.first_request_timestamp.seconds

Segundos UTC desde Unix epoch (1970-01-01T00:00:00Z). Debe estar entre 0001-01-01T00:00:00Z y 9999-12-31T23:59:59Z (inclusive).

page_params.first_request_timestamp.nanos

Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos.

Parámetros de Ordenamiento

Parámetro

Descripción

order_params.order_key

Campo utilizado para ordenar los resultados.

order_params.order_direction

Dirección del ordenamiento. Valores permitidos: ORDER_DIRECTION_ENUM_UNSPECIFIED, ASC, DESC.

Filtros de Tokens

Parámetro

Descripción

account_id

Filtra por la referencia única de la cuenta asociada al token de acceso.

user_id

Filtra por la referencia única del usuario asociada al token de acceso.

grant_flow

Filtra por el flujo de autorización utilizado para generar el token de acceso. Valores permitidos: GRANT_FLOW_CLIENT_CREDENTIALS, GRANT_FLOW_PASSWORD, GRANT_FLOW_ENTITY_SETUP, GRANT_FLOW_LOGIN.

role

Filtra por el rol asociado al token de acceso.

Cuerpo de la Solicitud

Este endpoint no requiere un cuerpo de solicitud (request body).

Ejemplo de Solicitud

curl --location 'https://api.paas.sandbox.co.passportfintech.com/v1/iam/oauth/tokens' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Cuerpo de la Respuesta

  • Código HTTP: 200 OK

Ejemplo de Respuesta

{…}

Errores Comunes y Manejo

Código HTTP

Significado

Descripción

400

Bad Request

Parámetros de consulta inválidos o solicitud malformada.

401

Unauthorized

Token Bearer ausente, vencido o sin el alcance iam.oauth.tokens.list.get.

403

Forbidden

El usuario autenticado no tiene permiso para ver la lista de tokens.

500

Internal Server Error

Error inesperado. Reintente o contacte soporte si el problema persiste.

Buenas Prácticas

  • Usa el objeto pagination_info para iterar todas las páginas al recuperar tokens.

  • Audita periódicamente los tokens activos para cumplir con las políticas de seguridad.

  • Revoca inmediatamente tokens comprometidos o sin uso mediante el endpoint de Revocar Token.

  • Nunca expongas tokens sin procesar en logs o aplicaciones del lado del cliente.

  • Utiliza roles y scopes para aplicar modelos de acceso de mínimo privilegio.