Retrieve list of user credentials

get

{protocol}://{base-url}/api/v2/auth/credentials/

Returns a list of credentials for the authenticated user with full credential details by default
to optimize UI performance and eliminate N+1 API call patterns. The response excludes sensitive
information like passwords but includes usernames, state info, and metadata.

Use detailed=false for minimal responses containing only auth_id strings when performance is critical.
When detailed=false, the response is a flat JSON array of UUID strings (not objects).
Optionally filter by data product ID or other application contexts.

Query Params

dp_id

string

Data product ID(s) to filter by. Supports a single ID or a comma-separated list (e.g., dp_id=product1 or dp_id=product1,product2,product3). Returns credentials where any of the given IDs is among their associated data products.

authType

string

enum

Filter by authentication type (case-insensitive)

Allowed:

status

string

enum

Filter by connection status. Supports comma-separated values (e.g., status=connected or status=connected,not_connected). "connected" maps to ACTIVE status, "not_connected" maps to ERROR status.

Allowed:

detailed

string

enum

Defaults to true

Response detail level. When "true" (default), returns full credential details (same schema as single credential retrieval) for UI optimization to reduce N+1 API call patterns. When "false", returns a flat JSON array of auth_id UUID strings for performance-critical scenarios.

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200List of credentials retrieved successfully

400Bad Request - Invalid input parameters or validation errors

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

500Internal Server Error - Unexpected server error