TSG Control Plane API Documentation

website·Indexed 32 days ago

https://tsg.dataspac.es

API schema documentation for the TSG control plane, covering versions v0.18.0, v0.19.0, v0.20.0, and Next. Includes detailed specifications for data transfer objects (TransferEventDto, TransferDetailDto), credential management (CredentialContainer, Credential), and evaluation schemas (EvaluationContext, EvaluationDecision).

Tokens
821.6K
Snippets
4.2K
Records
6.3K
Agent score
52%

What's inside TSG

  1. Overview of TNO Security Gateway (TSG)

    v0.18.0
    The TNO Security Gateway (TSG) is a decentralized, standards-based platform that enables organizations to participate in data spaces. It allows parties to discover, negotiate, and exchange data while maintaining sovereignty and control over their assets. Key capabilities include digital identity management (via decentralized technologies), data space protocols for service discovery, secure data exchange planes, and policy-based access control for automated compliance.
  2. Overview of TSG Wallet

    The TSG Wallet is a Self-Sovereign Identity (SSI) wallet designed for multi-tier deployments in data spaces. It allows users to issue and store verifiable credentials and create presentations. In typical deployments, one or more wallets act as trust anchors (Dataspace Wallets) that issue credentials to individual participant wallets.
  3. Overview of TSG Development Tools

    v0.19.0

    Beyond the CLI, the TSG repository provides several operational and development tools:

    • E2E Testing Framework: Used for testing end-to-end dataspace scenarios.
    • OpenAPI Generator: Used for the automated generation of API documentation.
    • Configuration Documentation Generator: Used for the automated generation of configuration documentation.
  4. Overview of TSG shared libraries

    TSG utilizes a set of reusable libraries located in the libs/ directory to provide shared building blocks across multiple applications. These libraries handle platform-wide behaviors such as authorization, audit logging, and transfer handling. Developers should consult these shared libraries before creating app-specific code to ensure consistency and reuse.
  5. Overview of TSG shared libraries

    v0.19.0
    TSG utilizes a set of reusable libraries located in the libs/ directory that serve as shared building blocks for multiple applications. These libraries provide platform-wide behavior for authorization, audit logging, transfer handling, and cryptographic primitives. Developers should consult these shared library docs when extending existing applications, building new APIs/UIs on top of the platform, or seeking reusable modules to avoid duplicating app-specific code.
  6. Overview of TSG Wallet

    v0.20.0
    The TSG Wallet is a Self-Sovereign Identity (SSI) wallet designed for multi-tier deployments within data spaces. It enables the issuance and storage of verifiable credentials and the creation of presentations. In typical deployments, one or more wallets act as trust anchors (referred to as the Dataspace Wallet), while individual participants maintain their own wallets.
  7. Overview of TNO Security Gateway (TSG) Core Applications

    v0.20.0

    The TNO Security Gateway (TSG) v0.20.0 is a suite of interconnected applications providing a dataspace solution. The ecosystem consists of the following core components:

    • Control Plane: Orchestration layer for catalog management, contract negotiation, and transfer coordination.
    • Wallet: SSI management system for Decentralized Identifiers (DIDs) and verifiable credentials.
    • HTTP Data Plane: Lightweight layer for HTTP-based data sharing (consumer and provider).
    • Analytics Data Plane: (Active Development) Specialized for distributed analytics and privacy-preserving computation.
    • Analytics Orchestration: Participant-owned app for project agreements, catalog publication, and coordinating Analytics Data Plane instances.
    • SSO Bridge: Centralized authentication/authorization server supporting OAuth2.0, OpenID Connect, and Verifiable Presentations.
  8. Overview of TSG Wallet

    The TSG Wallet is a Self-Sovereign Identity (SSI) wallet designed for multi-tier deployments in data spaces. It allows for the issuance and storage of verifiable credentials and the creation of presentations. In typical deployments, one or more wallets act as trust anchors (Dataspace Wallets) that issue credentials to individual participant wallets.
  9. Overview of TNO Security Gateway (TSG) Core Applications

    The TNO Security Gateway (TSG) is a suite of interconnected applications designed for dataspace solutions. The architecture uses loose coupling via APIs and protocols. The ecosystem consists of the following core components:

    • Control Plane: Orchestration layer for catalog management, contract negotiation, and transfer coordination.
    • Wallet: SSI management system for DIDs and verifiable credentials.
    • HTTP Data Plane: Lightweight layer for HTTP-based data sharing (consumer and provider).
    • Analytics Data Plane: Specialized implementation for distributed analytics and privacy-preserving computation.
    • Analytics Orchestration: Participant-owned app for project agreements, catalog publication, and coordinating Analytics Data Plane instances.
    • SSO Bridge: Centralized authentication/authorization server supporting OAuth2.0, OpenID Connect, and Verifiable Presentations.
  10. Overview of common-signing-and-validation library

    v0.19.0
    The common-signing-and-validation library provides reusable cryptographic and trust-evaluation building blocks for TSG applications. It is designed to prevent incorrect duplication of security logic across applications. It handles signing JWTs/JWS, generating W3C Data Integrity proofs, validating credentials and presentations, resolving DIDs, and applying trust-anchor/status checks. Note that this library does not handle authorization decisions; it provides the validation data used by authorization or business logic.
  11. Overview of common-data-plane-api

    common-data-plane-api is a library providing reusable backend building blocks for TSG data-plane implementations. It standardizes the transfer controller shape, control-plane client wiring, and registration flows so that new data planes can be built without duplicating integration code. Key components include the TransferController, ITransferHandler interface, CommonDataPlaneModule, and shared client services for the control plane, wallet, catalog, and negotiation endpoints.
  12. Overview of TNO Security Gateway (TSG)

    The TNO Security Gateway (TSG) is a decentralized, standards-based platform that enables organizations to participate in data spaces. It allows parties to discover, negotiate, and exchange data while maintaining data sovereignty, privacy, and control over their assets. Key capabilities include digital identity management, data space protocols for service discovery, secure data exchange via specialized data planes, and policy-based access control using machine-readable policies.