IOXIO
Documentation portal
Schemas
consent-configuration.jsonConsent request tokenConsent tokendataspace-configuration.jsonparty-configuration.json

Schema for dataspace-configuration.json

Docs /Schemas /dataspace-configuration.json /

/.well-known/dataspace/dataspace-configuration.json

Type: object

This configuration is found on the dataspace base domain, for example at https://sandbox.ioxio-dataspace.com/.well-known/dataspace/dataspace-configuration.json. It lists all the relevant configuration of the dataspace, such as endpoints for different dataspace components.
Example:

{
    "dataspace_base_domain": "sandbox.ioxio-dataspace.com",
    "product_gateway_url": "https://gateway.sandbox.ioxio-dataspace.com",
    "definition_viewer_url": "https://definitions.sandbox.ioxio-dataspace.com",
    "developer_portal_url": "https://developer.sandbox.ioxio-dataspace.com",
    "docs_url": "https://docs.sandbox.ioxio-dataspace.com",
    "dataspace_name": "IOXIO Sandbox Dataspace",
    "authentication_providers": {
        "developer": {
            "base_url": "https://login.sandbox.ioxio-dataspace.com"
        },
        "end_user": {
            "base_url": "https://login.sandbox.ioxio-dataspace.com"
        }
    },
    "consent_providers": [
        {
            "base_url": "https://consent.sandbox.ioxio-dataspace.com"
        }
    ],
    "definitions": {
        "git": "https://github.com/ioxio-dataspace/sandbox-definitions.git",
        "web": "https://github.com/ioxio-dataspace/sandbox-definitions"
    }
}

root dataspace_base_domain
Type: string

The base domain for the whole dataspace, without any protocol. This is the domain at which for example the /.well-known/dataspace/dataspace-configuration.json is found.
Example:

"sandbox.ioxio-dataspace.com"

root product_gateway_url
Type: stringFormat: uri

The URL at which the Product Gateway of the dataspace is hosted and on which all the data products are accessed.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://gateway.sandbox.ioxio-dataspace.com"

root definition_viewer_url
Type: stringFormat: uri

The URL at which the Data Definition Viewer of the dataspace is hosted. This is where non-technical people can learn about the data products on the dataspace.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://definitions.sandbox.ioxio-dataspace.com"

root developer_portal_url
Type: stringFormat: uri

The URL where the Developer Portal for the dataspace is hosted. This is where developers can register their own data sources and applications.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://developer.sandbox.ioxio-dataspace.com"

root docs_url
Type: stringFormat: uri

The URL at which the API documentation is hosted.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://docs.sandbox.ioxio-dataspace.com"

root dataspace_name
Type: string

A human readable name for the dataspace
Example:

"IOXIO Sandbox Dataspace"

root authentication_providers
Type: object

root authentication_providers developer
Type: object

Details about authentication provider used to identify developers on the dataspace.
Example:

{
    "base_url": "https://login.sandbox.ioxio-dataspace.com"
}

root authentication_providers developer base_url
Type: stringFormat: uri

Base URL for the authentication provider. Appending /.well-known/openid-configuration will give the full URL to the openid-configuration.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://login.sandbox.ioxio-dataspace.com"

root authentication_providers end_user
Type: object

Details about authentication provider used to identify end users on the dataspace.
Example:

{
    "base_url": "https://login.sandbox.ioxio-dataspace.com"
}

root authentication_providers end_user base_url
Type: stringFormat: uri

Base URL for the authentication provider. Appending /.well-known/openid-configuration will give the full URL to the openid-configuration.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://login.sandbox.ioxio-dataspace.com"

root definitions
Type: object

root definitions git
Type: stringFormat: uri

The URL to the git repository of the definitions used on the dataspace.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://github.com/ioxio-dataspace/sandbox-definitions.git"

root definitions web
Type: stringFormat: uri

The URL to a human friendly view of the definitions git repository used on the dataspace.

Must be at least 1 characters long

Must be at most 2083 characters long


Example:

"https://github.com/ioxio-dataspace/sandbox-definitions"