Base configuration

Create base configuration

POST/v4/config/consent/data-space/base-configurations

Connects your organisation to its data marketplace. Give the base URL of the data marketplace and the client credentials that the data marketplace gave you. The service uses them to tell the data marketplace about your data disclosure agreement templates and records. An organisation has one base configuration.

The service does not call the data marketplace here: it checks the configuration only when it next sends a notification.

Errors: 400 when a field is missing, baseUrl is not a URL, or the organisation already has a base configuration (change it with PUT).

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/config/consent/data-space/base-configurations' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "baseUrl": "https://data-marketplace.example.com",
  "clientId": "marketplace-client-01",
  "clientSecret": "<client-secret>"
}'

{
  "baseConfigurations": {
    "id": "6af081702d6fb7b6ac6efc63",
    "baseUrl": "https://data-marketplace.example.com",
    "clientId": "marketplace-client-01",
    "clientSecret": "<client-secret>"
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:data-space:create

Body

application/json

baseUrlstring<uri>required
Base URL of the data marketplace.
clientIdstringrequired
Client ID that the data marketplace gave to your organisation.
clientSecretstringrequired
Client secret that the data marketplace gave to your organisation.

Response

application/json

The new base configuration.

baseConfigurationsobject
How your organisation connects to its data marketplace. The service reads <baseUrl>/.well-known/data-space-configuration and gets an access token from the data marketplace with the client credentials. It uses them to tell the data marketplace about your data disclosure agreement templates and records.