Autional Autional
API Reference GitHub autional.com →

GET /auth/api-keys

Query the current user's API Key list, never return plaintext or hash

API Key `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
page query integer No 1 Page number
page_size query integer No 20 Items per page
status query string No Status filter: active/inactive/revoked
environment query string No Environment filter: live/test
search query string No Search by name or prefix

Responses

StatusDescriptionSchema
200API Key listdto.ApiKeyListResponse

Referenced Schemas

dto.ApiKeyListResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
items array of

See dto.ApiKeyResponse

No Use items uniformly
message string No
pagination object No Pagination info (nested object)
timestamp string No
total integer No Total count (flattened for direct reading)

dto.ApiKeyResponse

FieldTypeRequiredExampleConstraintsDescription
created_at string No 2024-01-01T00:00:00Z
environment string No live
expires_at string No 2025-01-15T00:00:00Z
id string No 01ARZ3NDEKTSV4RRFFQ69G5FAV
ip_restrictions array of

See dto.ipRestrictionDTO

No
last_used_at string No 2024-01-15T10:30:00Z
last_used_ip string No 192.168.1.100
name string No my-api-key
scopes array of

string

No ['["read"', '"write"]']
status string No active
tenant_id string No 01ARZ3NDEKTSV4RRFFQ69G5FAV
updated_at string No 2024-06-15T12:00:00Z
usage_count integer No 42
user_id string No 01ARZ3NDEKTSV4RRFFQ69G5FAV

dto.ipRestrictionDTO

FieldTypeRequiredExampleConstraintsDescription
id string No
label string No
status string No
value string No

gitee_com_linmes_authms_base_dto.PageInfo

FieldTypeRequiredExampleConstraintsDescription
has_next boolean No HasNext indicates whether there is a next page
has_prev boolean No HasPrev indicates whether there is a previous page
page integer No Page is the current page number (1-based)
page_size integer No PageSize is the number of items per page
total integer No Total is the total number of items across all pages
total_pages integer No TotalPages is the total number of pages