Herald
OpenapiApi keys

List all API Keys for a realm

Returns a paginated list of API keys. Hash and plaintext are never exposed.

GET
/api/api-keys/{realmId}

Returns a paginated list of API keys. Hash and plaintext are never exposed.

Path Parameters

realmId*string

Realm ID

Query Parameters

page?integer

Page number (0-based, default 0)

Formatint64
pageSize?integer

Page size (default 20)

Formatint64

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/api-keys/string"
{  "items": [    {      "clientAppId": "d386372c-64d9-49da-bb8b-4b5eda60f56c",      "clientAppName": "string",      "createdAt": "string",      "enabled": true,      "expiresAt": "string",      "id": "string",      "lastUsedAt": "string",      "name": "string",      "realmId": "string",      "roles": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string"        }      ]    }  ],  "page": 0,  "pageSize": 0,  "total": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}