# X-Road (NIIS) Clients API

**Canonical:** https://apis.io/apis/x-road-global/x-road-global-clients-api/  
**Provider:** X-Road (NIIS) — https://apis.io/providers/x-road-global/  
**Base URL:** https://{security-server-host}:4000/api/v1  
**Documentation:** https://docs.x-road.global/

X-Road (NIIS) Clients API is one of 40 APIs that [X-Road (NIIS)](https://apis.io/providers/x-road-global/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 4 JSON Schema definitions. Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification and 4 JSON Schemas.

resources related to Clients (Members and Subsystems)

## Operations (29)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (5)

- **OpenAPI** — https://artifacts.apis.io/x-road-global/openapi/x-road-global-clients-api-openapi.yml
- **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

## Other X-Road (NIIS) APIs (12)

- [X-Road Management Services (SOAP)](https://apis.io/apis/x-road-global/management-services/)
- [X-Road Environmental and Operational Monitoring (SOAP)](https://apis.io/apis/x-road-global/monitoring/)
- [X-Road (NIIS) Backups API](https://apis.io/apis/x-road-global/x-road-global-backups-api/)
- [X-Road (NIIS) Certificate Authorities API](https://apis.io/apis/x-road-global/x-road-global-certificate-authorities-api/)
- [X-Road (NIIS) Certification Services API](https://apis.io/apis/x-road-global/x-road-global-certification-services-api/)
- [X-Road (NIIS) Configuration Parts API](https://apis.io/apis/x-road-global/x-road-global-configuration-parts-api/)
- [X-Road (NIIS) Configuration Source Anchors API](https://apis.io/apis/x-road-global/x-road-global-configuration-source-anchors-api/)
- [X-Road (NIIS) Configuration Sources API](https://apis.io/apis/x-road-global/x-road-global-configuration-sources-api/)
- [X-Road (NIIS) Dataspace API](https://apis.io/apis/x-road-global/x-road-global-dataspace-api/)
- [X-Road (NIIS) Diagnostics API](https://apis.io/apis/x-road-global/x-road-global-diagnostics-api/)
- [X-Road (NIIS) Ds Tls Certification Authorities API](https://apis.io/apis/x-road-global/x-road-global-ds-tls-certification-authorities-api/)
- [X-Road (NIIS) Ds Tls Intermediate Cas API](https://apis.io/apis/x-road-global/x-road-global-ds-tls-intermediate-cas-api/)

## Tags

Clients

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/x-road-global/x-road-global-clients-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/x-road-global/.