Workflows
--The following APIs are defined for executing Verifiable Credential workflows. -
- --Workflows are an experimental feature that is currently being explored by the -group. This feature is likely to undergo significant revision as conversations -around the feature progress. -
+Exchange Examples
The APIs in this specification enables unmediated (automated, -machine-to-machine) or mediated (person in the loop) workflows to be -executed. These workflows are initiated by a Holder App and responded to by -any App that implements workflows. The flows consist of the following steps: +machine-to-machine) or mediated (person in the loop) exchanges to be +executed. These exchanges are initiated by a Holder App and responded to by +any App that implements exchanges. The flows consist of the following steps:
- The Holder App contacts the receiving App to request the initiation of a -particular workflow. +particular exchange.
- The receiving App responds with a presentation request of some kind to authenticate and/or authorize the Holder App and provides the next hop in the -workflow as a URL. +exchange as a URL.
-
The Holder App responds to the receiving App with a Verifiable Presentation
@@ -624,10 +607,10 @@
Workflows
A diagram of the steps outlined above is presented below: -
+ 
-The general workflow above can be performed in a way that is fully automated, +The general exchange above can be performed in a way that is fully automated, mediated by a person, or in a hybrid fashion where portions are automated but interaction by a person is required at certain stages. The second step above is used to provide guidance on whether the next step is automated or @@ -640,8 +623,8 @@
Workflows
-POST /workflows/refresh-degree/start HTTP/1.1 + title="Step 1 (request to issuer): Initiate degree refresh exchange"> +POST /exchanges/refresh-degree HTTP/1.1 Host: example.edu Content-Type: application/json Accept: application/json, */* @@ -676,7 +659,7 @@
Workflows
"interact": { "service": [{ "type": "UnmediatedPresentationService2021", - "serviceEndpoint": "https://example.edu/workflows/123456/presentations" + "serviceEndpoint": "https://example.edu/exchanges/refresh-degree/0bc42ece-89f7-11ec-9af0-136dfa9e4dbb" }] } } @@ -700,16 +683,9 @@Workflows
`MediatedPresentationService2021`. --We should make it clear that Issuers can choose to use one or more presentation -request formats simultaneously in order to maximize the chances that a given -client will be able to respond to a refresh workflow. This should probably be -more clearly stated in the VC-API specification. -
--POST /workflows/123456/presentations HTTP/1.1 +POST /exchanges/refresh-degree/0bc42ece-89f7-11ec-9af0-136dfa9e4dbb HTTP/1.1 Host: example.edu Content-Type: application/json Accept: application/json, */* @@ -746,7 +722,7 @@
- -Workflows
}, "refreshService": { "type": "AutoRefresh2021", - "url": "https://example.edu/workflows/refresh-degree/start", + "url": "https://example.edu/exchanges/refresh-degree", "validAfter": "2021-09-01T19:23:24Z" }, "proof": { @@ -806,7 +782,7 @@Workflows
}, "refreshService": { "type": "AutoRefresh2021", - "url": "https://example.edu/workflows/refresh-degree/start", + "url": "https://example.edu/exchanges/refresh-degree", "validAfter": "2027-03-14T19:23:24Z", "validUntil": "2027-07-14T19:23:24Z" }, @@ -821,46 +797,7 @@Workflows
}] }- - -Start Workflow
--The existing Presentation Availability -endpoint requires a Verifiable Presentation to be submitted to the endpoint. -The Start Workflow endpoint defined here generalizes the Presentation Availability endpoint by -allowing arbitrary data to be posted to the endpoint. It is suggested that we -can merge the API endpoint defined in this section with the Presentation Availability endpoint via -the generalization provided in this section. The term "workflow" is a working -title and is not intended to be the final feature name. -
- -- -Workflow Interaction
- --The existing Submit Presentation endpoint is -highly similar to this endpoint and only differs in the return values provided -by the endpoint. The Workflow Interaction endpoint defined here -generalizes the Submit Presentation endpoint -by allowing more variability in what is returned to the client and leaving some -of the HTTP response codes undefined (which can be extended through other -application-specific means). It is suggested that we can merge the API endpoint -defined in this section with the Submit -Presentation endpoint via the generalization provided in this section. The -term "workflow" is a working title and is not intended to be the final feature -name. -
- - -