Management API

The status lists every issued Verifiable Credential names, and suspending, reinstating or revoking one: Monitoring → Verifiable Credentials (/admin/vc/monitor) in the console.

Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.

A refusal

Unless an operation below says otherwise, any status it does not list answers this:

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean    
status integer    
why string    

GET /admin-api/vc-status

getCredentialStatus

This realm’s credential status lists

Where this realm’s Token Status List (tokenStatusList, draft-ietf-oauth-status-list), its aggregation and its two Bitstring Status List credentials (bitstring) are served, the list size and bits, ttlS and lifetimeS, the counts (allocated, valid, suspended, invalid), and a page of rows — each issued credential’s idx, format, configId, effective status (VALID, INVALID or SUSPENDED), the explicit status set here, via, changedAt, allocatedAt and expiresAt — answered in rowsPaging.

Mirrors GET /admin/vc/monitor on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
page query integer   Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is.
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The lists and their credentials.

Member Type Required What it is
aggregation string    
allocated integer    
bits integer    
bitstring list    
bitstring[] string    
invalid integer    
lifetimeS number    
rows list    
rows[].allocatedAt number    
rows[].artifactKey string, or null    
rows[].changedAt number, or null    
rows[].configId string    
rows[].expiresAt number, or null    
rows[].explicit string    
rows[].format string    
rows[].idx integer    
rows[].status string    
rows[].via string, or null    
rowsPaging object    
rowsPaging.firstRow integer    
rowsPaging.lastRow integer    
rowsPaging.noun string    
rowsPaging.page integer    
rowsPaging.pages integer    
rowsPaging.param string    
rowsPaging.perPage integer    
rowsPaging.total integer    
size integer    
suspended integer    
tokenStatusList string    
ttlS number    
valid integer    

POST /admin-api/vc-status/publish

publishStatusList

Publish one Bitstring Status List

The W3C test suites’ “publish the list now”, for the revocation or suspension Bitstring Status List. A list here is computed on every read from the statuses set so far, so it is current already: the answer says so, and the next fetch serves every status, signed afresh. A purpose that is neither is 400 with errors.

Mirrors POST /admin/vc/monitor on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
purpose one of revocation, suspension yes Which list.

200: The purpose, and that the list is current.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
published boolean    
purpose string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
published boolean    
purpose string    

POST /admin-api/vc-status/reinstate

reinstateCredential

Reinstate a suspended credential (VALID)

Sets the status-list entry idx names, in this realm’s Token Status List and Bitstring Status Lists at once. A credential that is not VALID is refused by every verifier reading the list and signs nobody in at /authn/wallet. reinstate applies to a SUSPENDED credential only; INVALID is final. A refusal is 400 with errors.

Mirrors POST /admin/vc/monitor on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
idx integer yes The index, as GET /admin-api/vc-status lists it.

200: The index and its new status.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string    

POST /admin-api/vc-status/revoke

revokeCredential

Revoke one issued credential (INVALID, final)

Sets the status-list entry idx names, in this realm’s Token Status List and Bitstring Status Lists at once. A credential that is not VALID is refused by every verifier reading the list and signs nobody in at /authn/wallet. reinstate applies to a SUSPENDED credential only; INVALID is final. A refusal is 400 with errors.

Mirrors POST /admin/vc/monitor on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
idx integer yes The index, as GET /admin-api/vc-status lists it.

200: The index and its new status.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string    

POST /admin-api/vc-status/suspend

suspendCredential

Suspend one issued credential (SUSPENDED)

Sets the status-list entry idx names, in this realm’s Token Status List and Bitstring Status Lists at once. A credential that is not VALID is refused by every verifier reading the list and signs nobody in at /authn/wallet. reinstate applies to a SUSPENDED credential only; INVALID is final. A refusal is 400 with errors.

Mirrors POST /admin/vc/monitor on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
idx integer yes The index, as GET /admin-api/vc-status lists it.

200: The index and its new status.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
idx integer    
message string    
ok boolean yes  
status string