X-Road (NIIS)

X-Road (NIIS) Clients API

resources related to Clients (Members and Subsystems)

GitHub OpenAPI

Operations 29

GET /clients find clients #
POST /clients Add new client for the security server #
GET /clients/{id} get security server client information #
PATCH /clients/{id} update security server client information #
DELETE /clients/{id} delete security server client #
GET /clients/{id}/local-groups get local groups for the selected client #
POST /clients/{id}/local-groups add new local group for the security server client #
GET /clients/{id}/orphans get information about orphaned sign keys, certificates and csrs left behind a… #
DELETE /clients/{id}/orphans delete orphaned sign keys, certificates and csrs left behind a delete client #
PUT /clients/{id}/register register security server client #
GET /clients/{id}/security-servers get all clients security servers #
GET /clients/{id}/service-clients get service clients for the selected client's services #
GET /clients/{id}/service-clients/{sc_id} get single service client by client id and service client id #
GET /clients/{id}/service-clients/{sc_id}/access-rights get access rights for the selected service client #
POST /clients/{id}/service-clients/{sc_id}/access-rights Add new access rights for selected service client. #
POST /clients/{id}/service-clients/{sc_id}/access-rights/delete remove access rights #
GET /clients/{id}/sign-certificates get security server client certificates information #
GET /clients/{id}/tls-certificates get security server client TLS certificates information #
POST /clients/{id}/tls-certificates add new certificate for the security server client #
GET /clients/{id}/tls-certificates/{hash} get TLS certificate #
DELETE /clients/{id}/tls-certificates/{hash} delete certificate #
PUT /clients/{id}/unregister unregister security server client #
GET /clients/{id}/service-descriptions get security server client service descriptions #
POST /clients/{id}/service-descriptions add new service description for the security server client #
GET /clients/{id}/service-client-candidates find ServiceClient candidates for a specific client #
PUT /clients/{id}/make-owner make client Security Server's owner. #
PUT /clients/{id}/disable disable security server client #
PUT /clients/{id}/enable enable security server client #
PUT /clients/{id}/rename rename security server client #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/x-road-global/openapi/x-road-global-clients-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/x-road-global/json-schema/x-road-global-certificate-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/x-road-global/json-schema/x-road-global-client-schema.json
📊
JSONSchema
https://artifacts.apis.io/x-road-global/json-schema/x-road-global-service-schema.json
📊
JSONSchema
https://artifacts.apis.io/x-road-global/json-schema/x-road-global-token-certificate-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/x-road-global:x-road-global-clients-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

x-road-global-clients-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: X Road Global Clients API
  contact:
    email: info@niis.org
    name: Nordic Institute for Interoperability Solutions (NIIS)
    url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
  description: 'Operations tagged clients across 4 of this provider''s published API definitions: central-server-admin-openapi.yaml, security-server-admin-openapi.yaml, x-road-global-central-server-admin-openapi.yml, x-road-global-security-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: basepath for API v1
  url: /api/v1
security:
- ApiKeyAuth: []
tags:


# --- truncated at 32 KB (87 KB total) ---
# Full source: https://artifacts.apis.io/x-road-global/openapi/x-road-global-clients-api-openapi.yml