Skip to main content
GET
/
api
/
adm
/
KeyStores
Get Keystore Entries
curl --request GET \
  --url https://localhost:44371/api/adm/KeyStores \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Returns a list of keystores configured in the system. Useful for key rotation planning, audit purposes, and understanding which keys are available for decrypting historical data.

​
Input

  • Query Parameters: request (KeystoreQueryRequest) — Filtering options including:
    • id (guid, optional) — Filter by specific keystore identifier.
    • isActive (bool, optional) — Filter by active status.
    • activationDate (datetime, optional) — Filter by activation date range.

​
Output

Returns a KeystoreQueryResponse containing matching keystore entries or an empty list if none found.

​
Example Request

GET /api/admin/KeyStores?id=3fa85f64-5717-4562-b3fc-2c963f66afa6
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "activationDate": "2024-01-01T00:00:00Z",
      "expirationDate": "2024-12-31T23:59:59Z",
      "isActive": true,
      "description": "Q1 2024 Encryption Key"
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid query parameters.
  • 401 Unauthorized — Missing or invalid authentication.
  • 404 Not Found — No keystores match specified criteria.
  • 500 Internal Server Error — Unexpected error while retrieving keystores.

​
Notes

  • Key material is never returned in query responses for security reasons.
  • Only metadata (ID, dates, status) is provided.
  • Common patterns: retrieve active keystores, list all for audit, find by date ranges, identify nearing expiration.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Returns the matching keystore entries (may be an empty list if no matches found).

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents the paginated response produced when key store entries are queried.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]