Skip to content

List Api Keys

GET
/auth/api-keys

List all API keys owned by the current user.

Does not return the plaintext key (use creation response to get key).

Args: user_payload: Authenticated user payload db: Database session

Returns: List of user’s API keys (without plaintext key)

Successful Response

Response List Api Keys Auth Api Keys Get
Array<object>
APIKeyResponse

API key response.

object
id
required
Id
string
name
required
Name
string
key
Any of:
string
scopes
Scopes
Array<string>
default:
created_at
required
Created At
string format: date-time
revoked_at
Any of:
string format: date-time
last_used_at
Any of:
string format: date-time

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object