Essence.Directory.PublicKey.Api
Generated from the PublicKeyDirectory service's code at build time (api-specs/generated/PublicKeyDirectory/Essence.Directory.PublicKey.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.
PublicKeys
GET
/api/v1/encryption/consistency-proofAuthentication: not declared in the document
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
oldSize | query | integer (int64) | no | — |
Request body
No request body.
Responses
200Success —
ConsistencyProofResponseDtoGET
/api/v1/encryption/log-keyAuthentication: not declared in the document
Parameters
Takes no parameters.
Request body
No request body.
Responses
200Success
POST
/api/v1/encryption/public-keyAuthentication: not declared in the document
Parameters
Takes no parameters.
Request body
Not marked as required in the document.
PublishKeyRequestDtoasapplication/*+json,application/json,text/json
Responses
200Success —
PublishKeyResponseDtoGET
/api/v1/encryption/public-key/{principalId}Authentication: not declared in the document
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
principalId | path | string (uuid) | yes | — |
keyType | query | string | no | — |
principalType | query | string | no | — |
scopeId | query | string (uuid) | no | — |
Request body
No request body.
Responses
200Success —
PublicKeyResponseDto404Not Found —
ProblemDetailsGET
/api/v1/encryption/tree-headAuthentication: not declared in the document
Parameters
Takes no parameters.
Request body
No request body.
Responses
200Success —
SignedTreeHeadDtoSchemas
ConsistencyProofResponseDto
| Property | Type | Required | Description |
|---|---|---|---|
newSize | integer (int64) | no | — |
oldSize | integer (int64) | no | — |
proofBase64Url | string[] | null | no | — |
treeHead | SignedTreeHeadDto | no | — |
ProblemDetails
| Property | Type | Required | Description |
|---|---|---|---|
detail | string | null | no | — |
instance | string | null | no | — |
status | integer (int32) | null | no | — |
title | string | null | no | — |
type | string | null | no | — |
PublicKeyResponseDto
| Property | Type | Required | Description |
|---|---|---|---|
inclusionProofBase64Url | string[] | null | no | — |
keyEpoch | integer (int32) | no | — |
keyType | string | null | no | — |
principalId | string (uuid) | no | — |
principalType | string | null | no | — |
publicKeyBase64Url | string | null | no | — |
scopeId | string (uuid) | no | — |
sequenceNumber | integer (int64) | no | — |
treeHead | SignedTreeHeadDto | no | — |
PublishKeyRequestDto
| Property | Type | Required | Description |
|---|---|---|---|
keyEpoch | integer (int32) | no | — |
keyType | string | null | no | — |
principalId | string (uuid) | no | — |
principalType | string | null | no | — |
publicKeyBase64Url | string | null | no | — |
scopeId | string (uuid) | null | no | — |
PublishKeyResponseDto
| Property | Type | Required | Description |
|---|---|---|---|
sequenceNumber | integer (int64) | no | — |
treeHead | SignedTreeHeadDto | no | — |
SignedTreeHeadDto
| Property | Type | Required | Description |
|---|---|---|---|
rootHashBase64Url | string | null | no | — |
signatureBase64Url | string | null | no | — |
timestampMs | integer (int64) | no | — |
treeSize | integer (int64) | no | — |