Learn

Policy

Publish policy

Publish a new version of the ecosystem policy. Only active and currently valid participants and IACA certificates are included in the policy.

Analytic events

  • ECOSYSTEM_POLICY_CREATE_START
  • ECOSYSTEM_POLICY_CREATE_SUCCESS
  • ECOSYSTEM_POLICY_CREATE_FAIL
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses
201

Ecosystem policy published

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

500

Internal Server Error. An unexpected error occurred.

post/v1/ecosystems/{ecosystemId}/policies
Request samples 
Response samples 
application/json
{
  • "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",
  • "policyPublishedAt": "2024-10-22T00:00:00Z"
}
Retrieve latest ecosystem policy
Retrieves an ecosystem policy by providing the ecosystem ID.


Analytic events


    

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_START
    • 

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS
    • 

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
header Parameters
If-None-Match
string
The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since.


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


 Enum: "gzip" "deflate"  
Responses 
200
Latest ecosystem policy retrieved


304
Not Modified. The resource has not been modified since the last request.


404
Not Found. The specified resource was not found.


get/v1/ecosystems/{ecosystemId}/policies/public/latest
Request samples 
Response samples 
application/json
{
  • "policyModifiedAt": "2023-10-17T00:00:00Z",
  • "policyPublishedAt": "2024-10-22T00:00:00Z",
  • "credentials": {
    },
  • "participants": {
    }
}
Retrieve ecosystem policyDeprecated
Retrieves an ecosystem policy by providing the ecosystem ID.


Analytic events


    

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_START
    • 

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS
    • 

  • ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
header Parameters
If-None-Match
string
The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since.


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


 Enum: "gzip" "deflate"  
Responses 
200
Ecosystem policy retrieved


304
Not Modified. The resource has not been modified since the last request.


404
Not Found. The specified resource was not found.


get/v1/ecosystems/{ecosystemId}/policy
Request samples 
Response samples 
application/json
{
  • "policyModifiedAt": "2023-10-17T00:00:00Z",
  • "policyPublishedAt": "2024-10-22T00:00:00Z",
  • "credentials": {
    },
  • "participants": {
    }
}
Retrieve ecosystem policy 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
    • 



SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
header Parameters
Accept-Encoding
string
Use the Accept-Encoding header to specify the supported content encodings.


 Enum: "gzip" "deflate"  
Responses 
200
Ecosystem policy preview retrieved


404
Not Found. The specified resource was not found.


get/v1/ecosystems/{ecosystemId}/preview
Request samples 
Response samples 
application/json
{
  • "policyModifiedAt": "2023-10-17T00:00:00Z",
  • "policyPublishedAt": "2024-10-22T00:00:00Z",
  • "credentials": {
    },
  • "participants": {
    }
}
➔ Next to Issuer Policies