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.
openapi: 3.2.0
info:
title: X Road Global Issuer Service API
version: 1.0.0
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
description: 'Operations tagged issuer-service across 2 of this provider''s published API definitions: central-server-admin-openapi.yaml, x-road-global-central-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:
- name: issuer-service
description: resources related to the Issuer Service's shared host
paths:
/issuer-service:
get:
operationId: getIssuerServiceState
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IssuerServiceState'
description: current Issuer Service host and binding state
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
summary: get the Issuer Service host and binding state
tags:
- issuer-service
servers:
- description: basepath for API v1
url: /api/v1
/issuer-service/host:
put:
operationId: setIssuerServiceHost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IssuerServiceHost'
description: new Issuer Service host
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IssuerServiceState'
description: Issuer Service host and binding state after the update
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'409':
$ref: '#/components/responses/Conflict'
'500':
$ref: '#/components/responses/InternalServerError'
summary: set the Issuer Service host
tags:
- issuer-service
servers:
- description: basepath for API v1
url: /api/v1
components:
schemas:
IssuerServiceState:
description: Issuer Service host and whether the issuer identity is bound
properties:
host:
description: the Issuer Service's shared host, or null when not yet set
format: text
type:
- string
- 'null'
bound:
description: whether the issuer identity is bound, so the host can no longer change
type: boolean
required:
- bound
type: object
IssuerServiceHost:
description: Issuer Service host to set
properties:
host:
description: the Issuer Service's shared host
format: text
type: string
required:
- host
type: object
responses:
Unauthorized:
description: authentication credentials are missing
Forbidden:
description: request has been refused
Conflict:
description: an existing item already exists
InternalServerError:
description: internal server error
BadRequest:
description: request was invalid
securitySchemes:
ApiKeyAuth:
description: X-Road-ApiKey token=<api key>
in: header
name: Authorization
type: apiKey
x-refined-from:
- central-server-admin-openapi.yaml
- x-road-global-central-server-admin-openapi.yml