Schemas
Shapes shared across more than one endpoint.
AppError
The stable error envelope. Key off code, never off message — the
prose may change, the code will not.
Messages may echo what the caller sent, never server-held state: an
error outlives the credential that produced it and lands in logs and
screenshots read by people who hold no key.
| Field |
Type |
Notes |
code |
string |
|
message |
string |
|
status |
integer |
|
data |
object |
Present on refusals PocketBase itself writes (collection rules, field validation). Each key is a field, carrying its own code and message; the top level then has no code. |
AttestationVerdict
The result of checking a credential. state is the answer;
the other fields say what it rests on.
state |
Meaning |
verified |
Both chains hold and the holder presented it. |
unverified |
A check could not be completed: the issuer or the holder's server was unreachable, the status list does not reach the credential, or no key binding was checked. |
dnsMissing |
The issuer publishes no _revoked TXT record. |
spoofed |
The credential is not signed by a key the issuer's DNS-pinned root key certified. |
revoked |
The credential is genuine, and the issuer revoked it or the holder's identity was withdrawn. |
expired |
The credential is genuine and past its own validity. |
invalid |
Not a readable credential, or the key binding does not verify. |
| Field |
Type |
Notes |
state |
string (verified | unverified | dnsMissing | spoofed | revoked | expired | invalid) |
|
reason |
string |
The first reason the credential was held back, or what was verified. |
issuer |
string |
The attesting domain. |
issuerState |
string |
How the issuer's key was tied to its domain. |
type |
string |
The credential's vct. |
claims |
object |
The disclosed claims. Left out unless the issuer's signature verified. |
withheld |
integer |
How many claims the credential holds that were not disclosed. |
status |
string (valid | revoked | unknown) |
What the issuer's status list says. |
issuedAt |
integer |
Unix seconds. |
expiresAt |
integer |
Unix seconds; absent when the credential does not expire. |
holder |
object |
The identity the credential was issued to. |
keyBound |
boolean |
Whether the presentation proved possession of the holder's key for the audience and nonce given. |
Feature
| Field |
Type |
Notes |
key |
string |
|
label |
string |
|
description |
string |
|
permission |
string |
The permission the feature is pointless without, or empty. A client hides the feature from a member who lacks it; holding the feature never grants the permission. |
defaultOn |
boolean |
Whether an account that never chose sees it. |
FeaturePreset
A kind of member an invite can be made for: the permissions it grants
and the features it starts the member on. The server stores the two
expanded lists; the preset's name is never kept.
| Field |
Type |
Notes |
key |
string |
|
label |
string |
|
description |
string |
|
permissions |
array of string |
|
features |
array of string |
|
IdentityStatusAssertion
A root-signed statement about one fingerprint.
| Field |
Type |
Notes |
payload |
string |
Base64url JSON. Its first field is type: identity-status-v1, which is what stops the endpoint being a signing oracle. |
signature |
string |
Root key signature over the payload. |
Member
| Field |
Type |
Notes |
id |
string |
|
user |
string |
|
email |
string |
|
features |
array of string |
What the member chose to see, or the catalogue's defaults while they never chose. Display only: gate on permissions. |
role |
string (admin | member) |
Derived, never chosen: set to admin exactly when the member may invite. Gate on permissions, not on this. |
permissions |
array of Permission |
|
isSelf |
boolean |
|
isLastAdmin |
boolean |
Removing them would leave the workspace unadministrable. |
joined |
string |
When the member joined, as PocketBase stores dates. |
Permission
| Field |
Type |
Notes |
key |
string |
|
label |
string |
|
description |
string |
|
destructive |
boolean |
Whether holding it lets someone extend or revoke other people's access. |
membersOnly |
boolean |
Held across the whole workspace only by a member. An API key or a connected tool holds a vault permission only within the sections chosen for it: creating a key with one and no sections, or with a raw record scope, fails with api_key_vault_scope. |
scopes |
array of string |
What the permission expands to when stored. |
ReissueVoucher
The old identity key's word that another identity takes over a
credential. payload is the exact bytes signed, as base64url without
padding; they are this JSON, with type first:
{ "type": "credential-reissue-v1", "issuer": "<issuer domain>",
"oldFingerprint": "<identity the credential is bound to>",
"newFingerprint": "<identity it moves to>", "nonce": "<the challenge>" }
signature is made like a challenge signature, over the SHA-256 of
the payload bytes: base64 of PKCS#1 v1.5 for an RSA key, of ASN.1 DER
for an ECDSA P-256 key. It is checked under the key in the
credential's cnf.jwk. The type tag keeps a voucher apart from
everything else the identity key signs.
| Field |
Type |
Notes |
payload |
string |
|
signature |
string |
|
ServerClaim
What the serving domain claims about itself. Verify it against DNS.
| Field |
Type |
Notes |
domain |
string |
|
rootFingerprint |
string |
|
Sharer
The identity behind a share or request. Every field here is a claim
until the chain is walked: fetch the named domain's root key, confirm
it against DNS, verify parentSignature, then ask the issuer whether
the identity still stands.
| Field |
Type |
Notes |
identityId |
string |
|
name |
string |
|
fingerprint |
string |
|
parentSignature |
string |
|
domainAtIssue |
string |
|
status |
string (active | revoked) |
|
statusAssertion |
IdentityStatusAssertion |
The issuer's signed answer, stapled so a verifier need not make a second round trip. |
TemplateItem
| Field |
Type |
Notes |
key |
string |
|
label |
string |
|
type |
string |
|
format |
string |
|
required |
boolean |
|
reason |
string |
Why the requester is asking for it. |
records |
array of TemplateItem |
Present when this item is a section. |