List Token Information

Overview

This endpoint retrieves a paginated list of all OAuth tokens issued for the entity. It includes metadata such as roles, scopes, expiration times, and creation dates. This is useful for auditing, monitoring active sessions, and managing token lifecycle.

Endpoint Details

Definition	Description
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/iam/oauth/tokens
Method	GET
Headers	Accept-Language, Content-Length, Content-Type: application/json, Authorization
Authentication	Access Token (Bearer Token)

Query Parameters

Pagination Parameters

Parameter	Description
page_params.page_size	Number of records to return per page.
page_params.page_number	Page number to retrieve.
page_params.first_request_timestamp.seconds	UTC seconds since Unix epoch (`1970-01-01T00:00:00Z`). Must be between `0001-01-01T00:00:00Z` and `9999-12-31T23:59:59Z` (inclusive).
page_params.first_request_timestamp.nanos	Nanosecond fraction (0 to 999,999,999). Must be a non-negative value and represents fractional seconds at nanosecond resolution.

Ordering Parameters

Parameter	Description
order_params.order_key	Field used to sort the results.
order_params.order_direction	Sort direction. Allowed values: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Token Filters

Parameter	Description
account_id	Filters by the unique account reference associated with the access token.
user_id	Filters by the unique user reference associated with the access token.
grant_flow	Filters by the grant flow used to generate the access token. Allowed values: `GRANT_FLOW_CLIENT_CREDENTIALS`, `GRANT_FLOW_PASSWORD`, `GRANT_FLOW_ENTITY_SETUP`, `GRANT_FLOW_LOGIN`.
role	Filters by the role associated with the access token.

Request Body

This endpoint does not require a request body.

Example Request

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

Response

HTTP Status Code 200 OK.

Example of Response

JSON
    
 
{
    "pagination_info": {...},
    "tokens": [...]
}
Copy

Common Errors and Handling

HTTP Status Code	Meaning	Description
400	Bad Request	Invalid query parameters or malformed request
401	Unauthorized	Bearer token missing, expired, or does not include `iam.oauth.tokens.list.get` scope
403	Forbidden	Authenticated user lacks permission to view token list
500	Internal Server Error	Unexpected error. Retry or contact support if issue persists

Best Practices

Use the pagination_info object to iterate through all pages when retrieving tokens.
Regularly audit active tokens to ensure compliance with security policies.
Immediately revoke compromised or unused tokens using the Revoke Token endpoint.
Never expose raw tokens in logs or client-side applications.
Use roles and scopes to enforce least-privilege access models.

Last updated on