light-mode-image
Learn
API ReferencePolicy

Retrieve ecosystem policy preview

Roles

admindts-provider

Analytics Events

ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_STARTECOSYSTEM_POLICY_PREVIEW_RETRIEVE_SUCCESSECOSYSTEM_POLICY_PREVIEW_RETRIEVE_FAIL
GET/v1/ecosystems/{ecosystemId}/preview

Retrieves an ecosystem policy preview by providing the Ecosystem's ID. A policy preview includes all the participants and credential types created in the ecosystem, excluding any participants with expired or inactive IACAs.

Analytic events

  • ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_START
  • ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_SUCCESS
  • ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

ecosystemId*string

The UUID of the ecosystem

Formatuuid

Header Parameters

Accept-Encoding?string

Use the Accept-Encoding header to specify the supported content encodings.

Value in

  • "gzip"
  • "deflate"

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/preview"
{  "policyModifiedAt": "2019-08-24T14:15:22Z",  "credentials": {    "599bf148-d711-405a-a20b-9c8a87ac8850": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "ecosystemId": "e2e92b49-5a4f-4804-83c0-325e709d9dcd",      "profile": "compact",      "type": "string",      "name": "string"    }  },  "participants": {    "a24e391a-c27f-4b6e-9805-1ee7e03f3c58": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "ecosystemId": "e2e92b49-5a4f-4804-83c0-325e709d9dcd",      "name": "string",      "isIssuer": false,      "isVerifier": false,      "isIssuerConstrained": true,      "isVerifierConstrained": true,      "status": "Active",      "country": "string",      "stateOrProvince": "string",      "organizationAddress": "string",      "organizationPhoneNumber": "string",      "identifiers": {        "web-semantic": "string",        "compact-semantic": "string",        "compact": "string",        "mobile": [          {            "certificatePem": "string",            "status": "Active",            "docTypes": [              "string"            ],            "validationResult": {              "validated": true,              "failReasons": [                "string"              ]            }          }        ]      },      "issuerAllowedCredentials": [        "7934b2fb-cc31-4cbd-a9e5-5d698652371c"      ],      "verifierAllowedCredentials": [        "39dbb02c-93c0-44c8-b558-dc1e075c9a61"      ]    }  }}

How would you rate this page?

Retrieve ecosystem policy ⚠️

Previous Page

Retrieve ecosystem policy GET

Retrieves an ecosystem policy by providing the ecosystem ID. This endpoint is intended for public consumption, and as such does not require authentication. ### **Analytic events** * ECOSYSTEM_POLICY_RETRIEVE_LATEST_START * ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS * ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL