Package co.ankatech.keymanagement.client.keymanagement.model
package co.ankatech.keymanagement.client.keymanagement.model
-
ClassDescriptionAbstract class for oneOf,anyOf schemas defined in OpenAPI specPer-action capability flag computed server-side.Activate a READY Exchange (creates the Capability Grant atomically)Cryptographic capability for the new Grant.Cryptographic Actor embedded summaryCryptographic Actor — the operational identity that authenticates and executes cryptographic operations on behalf of its parent Application.Operational classificationLifecycle state; only ACTIVE permits authenticationComponent of a composite hybrid key.Algorithm family of the component, derived from the component algorithm.Component role within the composite key.Public key material and full operational metadata for a tenant-scoped cryptographic key.How a composite key's components are combined — the construction axis that a coarse key type deliberately does not carry.How the key entered the platform (GENERATED or IMPORTED).Key structure: SIMPLE (single-algorithm key) or COMPOSITE (hybrid classical + PQC key).Documentation of the set of fields accepted on a key-metadata merge-patch request.Operational metadata for a tenant-scoped cryptographic key.Composite-key mode.Shape of the key (SIMPLE or COMPOSITE).How the key entered the platform (GENERATED or IMPORTED).The status the key held immediately before being suspended.Current lifecycle state.Detected algorithm and purpose for a single keystore alias (no key material).Purpose derived from the certificate's X.509 KeyUsage: ENCRYPT_DECRYPT, SIGN_VERIFY, or AMBIGUOUS (KeyUsage absent or spanning both families).An application registered under a tenant: identity, lifecycle, business identity, ownership, risk classification and metadata, as stored.Sensitivity of the data the application handles.Environment classification.Kind of principal; always `APPLICATION` on this record.Operational risk level.Lifecycle status of the application: `ACTIVE`, `SUSPENDED` (temporarily not admitted to cryptographic operations) or `DISABLED`.Cryptographic Asset REFERENCE.Rotation admissibility verdict for a single candidate target algorithm.Five-dimensional authorization: Actor × Capabilities × Asset(s) × ExchangeContext × ConstraintPolicy. capabilities is a JSONB array (e.gOne activation capability and whether it may be chosen.The capabilityClone an existing Exchange into DRAFT.What a conferral would do and whether it may happen. refusal is the problem document the corresponding write would return, with the same type URI, and is null when the conferral is admitted.Constraint Policy embedded summaryUsage restrictions attached to Capability Grants. rateLimitPerMinute=0 means fully blocked (emergency freeze); null means no rate limit.Exchange Context embedded summaryCounterparty type catalog entry as seen by the caller.Catalog scope.CreateCapabilityGrantRequestCreateConstraintPolicyRequestCreateExchangeContextRequestFlow direction.Data classification of the exchanged payloadProvision an internal crypto use case (Application self-use) as an authorization overlay over keys that ALREADY EXIST.Actor Credential embedded summary. clientSecret is plaintext on 201 only.Which compliance packs the maximum was read from.Key class a maximum cryptoperiod is chosen by, decided on the key's primary material: SYMMETRIC when kty is oct; otherwise ASYMMETRIC_SIGNING when keyOps contain sign; PUBLIC_VERIFICATION when they contain only verify; otherwise ASYMMETRIC_KEY_ESTABLISHMENT.What activating, resuming or inspecting this Exchange would confer.The Exchange's current lifecycle statusWhich operation this preview is aboutGoverned interaction scenario between a tenant Application and a counterparty.Gets or Sets directionGets or Sets sensitivityGets or Sets statusCreate a Cryptographic Exchange in DRAFT statusFull Cryptographic Exchange detailLifecycle statusWhy the Exchange reached its terminal state.List-page projection of a Cryptographic ExchangeLifecycle statusWhy the Exchange reached its terminal state.Whether the Exchange's actor holds the operation scopes its grant needs.PATCH-style update for DRAFT or READY Exchange.An entry that failed validation or import.Entry type.Failure category: - CERTIFICATE_VALIDATION_FAILED: the certificate failed validation (STRICT mode), an expired or otherwise unacceptable certificate included - KEY_BINDING_FAILED: the entry's private key does not match its certificate - KEY_ID_RETIRED: the entry's Key ID belonged to a destroyed key of this tenant; a Key ID is never reused, so the entry needs another Key ID - UNEXPECTED_ERROR: an internal processing error; errorMessage carries a fixed textThe detected keystore format (informational only).Keystore format detected from the keystore's leading bytes. - PKCS12: detected from the 0x30 leading byte - JKS: detected from the 0xFEEDFEED magic number Both formats are supported for import.Format of the imported keystore (the same value as detectedFormat).Capability Grant embedded summary. capabilities mirrors the grant's JSONB capabilities array.The limits of the Constraint Policy version a grant enforces.The use that exhausted a Capability Grant, as the cryptographic service's consumption ledger recorded it.REVOKED_ON_USE: the single permitted use was taken.The capability grant a conferral would create.Metadata about a successfully imported trusted certificate (CA).Metadata about a successfully imported private key.Lifecycle state, as the lower-case wire alias of the key-status vocabulary: active, pending_rotation, rotated, expired, revoked, archived, suspended, pending_destruction, deleted_logical.Quick summary of a keystore import's results.InternalCryptoUseCase aggregate projection.Lifecycle stateWhy the use case was revoked.How many authorizations reference this key, by kind.Component for composite key import (public key only).Algorithm family (optional, can be inferred).Component of a composite hybrid key (public information only).A scheduled, executed, cancelled or failed destruction of a key or of one of its material versions: what the approval of a destruction request scheduled and how it ended.REQUEST when the request named the period; TENANT_POLICY or DEPLOYMENT_POLICY when it came from that lifecycle policy's default; DEFAULT for the platform's 30 days.KEY destroys every material the key had left and retires its Key ID for good; MATERIAL destroys one material version of a key that keeps another.SCHEDULED waits for its cooling-off period to end; EXECUTED destroyed the versions; CANCELLED was ended by a cancel, which restored the versions; FAILED destroyed nothing, because the versions were no longer the approved ones or could not be erased, and is never retried.Complete key metadata and PUBLIC key material.How a composite key's components are combined — the construction axis that a coarse key type deliberately does not carry.How the key was created: GENERATED or IMPORTED.Key structure: SIMPLE or COMPOSITE.Import request for a simple or composite (hybrid) PUBLIC cryptographic key.Key derivation function of an imported COMPOSITE_KEM_COMBINE key.Key structure: SIMPLE (default) or COMPOSITE.What one lifecycle act, taken under one cause, does to each read operation, and whether the act is admissible from the key's current status at all.The lifecycle act.Why a key left its operative state.Per-key server verdict: for each lifecycle act and each cause, which read operations stop, continue, or stop on some material versions only.The key's projected status today.Whether one read operation stops, continues, or stops on some material versions only, once the act is taken.The read leg.STOPS: refused on every evaluated material version (or there is none).A key's automatic-rotation schedule and one page of its executions, latest due first.Full replacement of the key's rotation schedule: its enablement, its optional cadence override and its usage options.Where the key stands with respect to automatic rotation.The key's effective automatic-rotation schedule: its enablement, the cadence it follows and where that comes from, its usage options, the ceilings applied, and the next instant the key is due.Read-only, per-alias analysis of a PKCS#12 / JKS keystore.The key derivations an import of the keystore would run, against the import budget.Comprehensive response for a keystore import (PKCS#12 / JKS).Summary metadata for a cryptographic key after a lifecycle operation (typically rotation: same kid, advanced material version).How a composite key's components are combined — the construction axis that a coarse key type deliberately does not carry.Current lifecycle state, relayed verbatim from the cryptographic service; the declared set is its vocabulary.Request to destroy an archived key once its destruction request is approved and its cooling-off period has elapsed.Request to destroy one material version once its destruction request is approved and its cooling-off period has elapsed.MaterialRevokeRequestMaterialVersionResponseWhat a destruction request for this version requests: MATERIAL destroys this version alone; KEY, when the key has no other version outside a destruction, destroys the whole key and retires its Key ID, and needs admin.keys.mark-for-destruction and an ARCHIVED key.Per-material lifecycle status.What a conferral would add to the actor. required and confersNew always answer; alreadyHeld and toAdd name scopes and are null unless the caller holds admin.tenant.actor.roles.read — namesVisible says which of the two shapes this is, so a withheld list is never confused with an empty one.Request for key creation.Key derivation function combining the component secrets of a COMPOSITE_KEM_COMBINE key.Cryptographic purpose.Response from key creation.PageableObjectPageActorResponsePageAdminKeyResponsePageApplicationResponsePageCapabilityGrantResponsePageConstraintPolicyResponsePageExchangeContextResponsePageExchangeListItemResponsePageInternalCryptoUseCaseResponseThe keys a PKCS#7 → JOSE conversion use case binds.Standard RFC 7807 problem envelope.Why a key can no longer encrypt or sign.One approver's decision on a quorum request.APPROVE counts toward the quorum; one REJECT ends the request.What a destruction request asks to destroy, and the cooling-off period its approval schedules.REQUEST, TENANT_POLICY, DEPLOYMENT_POLICY or DEFAULT.KEY destroys every version the key has left and retires its Key ID; MATERIAL destroys one version.One page of quorum requests, newest first.A gated operation waiting for, or decided by, its quorum of approvers.The gated operation.TENANT for a tenant's request; DEPLOYMENT for a platform request.IDENTITY when a person requested; WORKLOAD when an administrative workload identity did; APPLICATION when an application did, with its own token or an actor's.PENDING while it waits; EXECUTED once its quorum was reached and the operation ran; SCHEDULED when its quorum was reached and it takes effect at takesEffectAt (a platform recovery, which the tenant may cancel until then); FAILED when the operation refused to run at that moment (failureType says why); REJECTED by an approver; CANCELLED by its requester, by the tenant, or because its requester can no longer act; EXPIRED when it waited past expiresAt.Resume a SUSPENDED Cryptographic Exchange.Revoke a Cryptographic Exchange (irreversible).Revocation metadata for the audit trail and compliance reportingServer-authoritative rotation admissibility preview for a source key.Why a key's material was rotated.What a rotation-schedule write on this deployment admits beyond the interval grammar.New material spec for a Stable KID rotation (no kid).Key derivation function combining the component secrets of the successor COMPOSITE_KEM_COMBINE material.Parameters for a Stable KID rotation.Maximum cryptoperiod the compliance packs state for the key's class (NIST SP 800-57 Part 1 Rev. 5 §5.3.6), which bounds the key's rotation interval.Which bound brought the next rotation forward.Semantic version of each policy the key's schedule is composed from.Which policy the triggers come from.Rotation trigger, discriminated by `type`.One page of a schedule's executions, latest due first.One execution of a schedule: when it was due, the attempts it took and how it ended.One durable schedule of a tenant: the obligation it carries, the resource it acts on and its status.An entry skipped because it already exists (an idempotent re-import).SortObjectAlgorithm profile supported by the platform, including cryptographic capabilities, security classification, and lifecycle status.Algorithm category: CLASSICAL for traditional cryptography, POST_QUANTUM for quantum-resistant algorithms, HYBRID for composite algorithms combining both.Composite construction mode.Lifecycle status: RECOMMENDED for active use, EXPERIMENTAL for testing, LEGACY for deprecated algorithmsSuspend an ACTIVE Exchange Context.Suspend an ACTIVE Cryptographic Exchange.Suspend an ACTIVE internal crypto use case.Request to temporarily suspend a key for incident investigationThe key is due for rotation when the interval has elapsed since the activation of its primary material.PATCH-style update.Gets or Sets sensitivityResult of validating an Exchange's references and cross-entity invariantsValidationViolationValidationWarningOptional validity window, enforced by the cryptographic service on every request as [validFrom, validUntil).