General
Create a RICAL
/v1/ecosystems/{ecosystemId}/ricalsCreates a Reader Identity Certificate Authority List (RICAL) based on the policy of the requested ecosystem.
A RICAL configuration is required in order for RICALs to be created.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
The UUID of the ecosystem
uuidResponse Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals"{ "ricalIssueID": 0, "date": "2019-08-24T14:15:22Z"}Retrieve all RICALs
/v1/ecosystems/{ecosystemId}/ricals/publicRetrieves all RICALs available in the requested ecosystem.
The response is a JSON list of the published RICALs and their version identifiers. To download an actual RICAL file (a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5), call the Retrieve specific RICAL or Retrieve latest RICAL endpoint.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
Path Parameters
The UUID of the ecosystem
uuidQuery Parameters
Range size of returned list.
1 <= value <= 1000100Starting point for the list of entries.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/public"{ "data": [ { "ricalIssueID": 0, "date": "2019-08-24T14:15:22Z", "filename": "string", "isAutoPublished": true } ], "nextCursor": "string"}Retrieve a RICAL
/v1/ecosystems/{ecosystemId}/ricals/public/{ricalIssueId}Retrieves a specific RICAL from the requested ecosystem by providing the RICAL version identifier.
The response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
Path Parameters
The UUID of the ecosystem
uuidUnique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.
int32Response Body
application/cbor
application/json
curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/public/0""string"Retrieve latest RICAL
/v1/ecosystems/{ecosystemId}/ricals/public/latestRetrieves the latest RICAL from the requested ecosystem.
The response is a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5.
This endpoint is intended for public consumption, and as such does not require authentication.
Analytics Events
Path Parameters
The UUID of the ecosystem
uuidResponse Body
application/cbor
application/json
curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/public/latest""string"Delete a RICAL
/v1/ecosystems/{ecosystemId}/ricals/{ricalIssueId}Deletes a specific RICAL from the requested ecosystem by providing the RICAL version identifier. Deleting a RICAL also deletes the verifier policy published from it, if one exists. This action cannot be undone.
A 404 is only returned when the ecosystem does not exist. Deleting a ricalIssueId that does
not exist within an existing ecosystem still returns 204.
Roles
Analytics Events
Authorization
bearerAuth In: header
Path Parameters
The UUID of the ecosystem
uuidUnique identifier of a specific RICAL version. This numeric value is continuously increased whenever a RICAL is created.
int32Response Body
application/json
application/json
curl -X DELETE "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/0"How would you rate this page?
Last updated on