Begin a key rotation for a published identifier
POST/api/v1/identifiers/:id/update
Requires Idempotency-Key; takes no body. Generates a new assertion key and renders the document again with it. The identifier returns to state prepared and the version already published stays served; preview the new document, then publish it. For webvh the publication appends one log entry, signed by the current update key, that a verifier can check against the entry before. For web it overwrites the document, and nothing lets a verifier tell that from a substitution. The replaced key is kept and listed in retiredAssertionKeyIds, because a credential signed under it must stay verifiable. The host and the method cannot be changed. An identifier that is not published is refused with 409.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
- 500
- 502
- 503
The identifier, in state prepared again.
Response Headers
The correlation id of the request, on every response including 401.
The request is malformed. callerShould: fix-and-retry.
Response Headers
The correlation id of the request, on every response including 401.
Authentication is required. callerShould: authenticate.
Response Headers
The correlation id of the request, on every response including 401.
The token is valid but maps to no usable principal. callerShould: stop.
Response Headers
The correlation id of the request, on every response including 401.
The resource was not found. The same answer for a subject that does not exist and one outside the caller's scope. callerShould: stop.
Response Headers
The correlation id of the request, on every response including 401.
The resource is not in a state that allows this (callerShould: re-read-and-decide), or A concurrent change conflicted with this request (callerShould: re-read-and-retry-once). Told apart by the type URI; the code member names the refusal (for example subject.slug_taken). A conflict the module marked not retryable carries callerShould: re-read-and-decide.
Response Headers
The correlation id of the request, on every response including 401.
Too many requests. The rate limit for this caller was reached: 600 a minute per authenticated principal, 60 a minute per client address before authentication (both configurable). callerShould: retry-with-backoff, after the number of seconds in Retry-After.
Response Headers
The correlation id of the request, on every response including 401.
Whole seconds to wait before the next request.
An internal error occurred. callerShould: retry-with-backoff.
Response Headers
The correlation id of the request, on every response including 401.
A system we depend on failed. callerShould: retry-with-backoff.
Response Headers
The correlation id of the request, on every response including 401.
The service cannot serve this right now. callerShould: retry-with-backoff.
Response Headers
The correlation id of the request, on every response including 401.