Download OpenAPI specification:
Contract-only API key lifecycle endpoints. This document does not imply a runtime backend implementation.
| X-Correlation-Id required | string Required for all requests; echoed into responses and audit. |
| X-Idempotency-Key required | string Required for write operations; enforces deterministic replay semantics. |
| display_name required | string |
| scopes required | Array of strings |
| expires_at | string or null <date-time> |
| requested_by | string or null Actor hint for contracts/fixtures only; runtime must derive actor identity from auth. |
{- "display_name": "string",
- "scopes": [
- "string"
], - "expires_at": "2019-08-24T14:15:22Z",
- "requested_by": "string"
}{- "outcome": "APPLIED",
- "reason_code": "string",
- "key_id": "string",
- "key_last4": "string",
- "api_key_secret": "string",
- "correlation_id": "string",
- "idempotency_key": "string",
- "audit_event_id": "string"
}| X-Correlation-Id required | string Required for all requests; echoed into responses and audit. |
{- "keys": [
- {
- "key_id": "string",
- "display_name": "string",
- "status": "ACTIVE",
- "scopes": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "last_used_at": "2019-08-24T14:15:22Z",
- "key_last4": "string"
}
], - "correlation_id": "string",
- "audit_event_id": "string"
}| key_id required | string |
| X-Correlation-Id required | string Required for all requests; echoed into responses and audit. |
| X-Idempotency-Key required | string Required for write operations; enforces deterministic replay semantics. |
| reason | string or null |
| requested_by | string or null |
{- "reason": "string",
- "requested_by": "string"
}{- "outcome": "APPLIED",
- "reason_code": "string",
- "key_id": "string",
- "key_last4": "string",
- "api_key_secret": "string",
- "correlation_id": "string",
- "idempotency_key": "string",
- "audit_event_id": "string"
}| key_id required | string |
| X-Correlation-Id required | string Required for all requests; echoed into responses and audit. |
| X-Idempotency-Key required | string Required for write operations; enforces deterministic replay semantics. |
| reason | string or null |
| requested_by | string or null |
{- "reason": "string",
- "requested_by": "string"
}{- "outcome": "APPLIED",
- "reason_code": "string",
- "key_id": "string",
- "key_last4": "string",
- "api_key_secret": "string",
- "correlation_id": "string",
- "idempotency_key": "string",
- "audit_event_id": "string"
}