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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/x-road-global:x-road-global-local-groups-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: X Road Global Local Groups API
version: 2.1.0
contact:
name: Nordic Institute for Interoperability Solutions (NIIS)
url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
email: info@niis.org
license:
name: MIT
url: https://opensource.org/licenses/MIT
description: 'Operations tagged local-groups across 2 of this provider''s published API definitions: security-server-admin-openapi.yaml, x-road-global-security-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v1
description: basepath for API v1
security:
- ApiKeyAuth: []
tags:
- name: local-groups
description: local groups endpoints
paths:
/local-groups/{group_id}:
get:
tags:
- local-groups
summary: get local group information
operationId: getLocalGroup
description: Administrator views local group details.
parameters:
- in: path
name: group_id
description: id of the local group
required: true
schema:
type: string
format: text
minLength: 1
responses:
'200':
description: group object
content:
application/json:
schema:
$ref: '#/components/schemas/LocalGroup'
'400':
description: request was invalid
'401':
description: authentication credentials are missing
'403':
description: request has been refused
'404':
description: resource requested does not exists
'406':
description: request specified an invalid format
'500':
description: internal server error
patch:
tags:
- local-groups
summary: update local group information
operationId: updateLocalGroup
description: Administrator updates the local group information.
parameters:
- in: path
name: group_id
description: id of the local group
required: true
schema:
type: string
format: text
minLength: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocalGroupDescription'
responses:
'200':
description: local group modified
content:
application/json:
schema:
$ref: '#/components/schemas/LocalGroup'
'400':
description: request was invalid
'401':
description: authentication credentials are missing
'403':
description: request has been refused
'404':
description: resource requested does not exists
'406':
description: request specified an invalid format
'500':
description: internal server error
delete:
tags:
- local-groups
summary: delete local group
operationId: deleteLocalGroup
description: Administrator deletes the local group.
parameters:
- in: path
name: group_id
description: id of the local group
required: true
schema:
type: string
format: text
minLength: 1
responses:
'204':
description: local group deletion was successful
'400':
description: request was invalid
'401':
description: authentication credentials are missing
'403':
description: request has been refused
'404':
description: resource requested does not exists
'500':
description: internal server error
servers:
- url: /api/v1
description: basepath for API v1
/local-groups/{group_id}/members:
post:
tags:
- local-groups
summary: add new member for the local group
operationId: addLocalGroupMember
description: 'Administrator adds a new member for the local group.
The new member can be an X-Road member or a subsystem.'
parameters:
- in: path
name: group_id
description: id of the local group
required: true
schema:
type: string
format: text
minLength: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Members'
responses:
'201':
description: new members added
content:
application/json:
schema:
$ref: '#/components/schemas/Members'
'400':
description: request was invalid
'401':
description: authentication credentials are missing
'403':
description: request has been refused
'404':
description: resource requested does not exists
'406':
description: request specified an invalid format
'409':
description: an existing item already exists
'500':
description: internal server error
servers:
- url: /api/v1
description: basepath for API v1
/local-groups/{group_id}/members/delete:
post:
tags:
- local-groups
summary: delete member from local group
operationId: deleteLocalGroupMember
description: Administrator deletes the member from local group.
parameters:
- in: path
name: group_id
description: id of the local group
required: true
schema:
type: string
format: text
minLength: 1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Members'
responses:
'204':
description: members deleted
'400':
description: request was invalid
'401':
description: authentication credentials are missing
'403':
description: request has been refused
'404':
description: resource requested does not exists
'406':
description: request specified an invalid format
'409':
description: an existing item already exists
'500':
description: internal server error
servers:
- url: /api/v1
description: basepath for API v1
components:
schemas:
LocalGroup:
type: object
description: group
required:
- code
- description
properties:
id:
type: string
format: text
description: unique identifier
example: 123
readOnly: true
code:
type: string
format: text
description: group code
example: groupcode
minLength: 1
maxLength: 255
description:
type: string
format: text
description: group description
example: description
minLength: 1
maxLength: 255
client_id:
type: string
format: text
description: <instance_id>:<member_class>:<member_code>:<subsystem>(optional)
example: FI:GOV:123:ABC
readOnly: true
minLength: 1
maxLength: 255
member_count:
type: integer
format: int32
description: member count
example: 10
minimum: 0
maximum: 1000000
updated_at:
type: string
format: date-time
description: last time updated
example: '2018-12-15T00:00:00.001Z'
minLength: 24
maxLength: 24
members:
type: array
description: group members
uniqueItems: true
items:
$ref: '#/components/schemas/GroupMember'
Members:
type: object
description: Request object containing an array of member ids. The id must be an X-Road member id or subsystem id
properties:
items:
type: array
description: array of members to be added
example:
- FI:GOV:123
- FI:GOV:123:SS1
- FI:GOV:123:SS2
items:
type: string
format: text
minLength: 1
maxLength: 1023
GroupMember:
type: object
description: group member
required:
- id
- member_name
- created_at
properties:
id:
type: string
format: text
description: group member id
example: FI:GOV:123
minLength: 1
maxLength: 1023
member_name:
type: string
format: text
description: group member name
example: Member123
minLength: 1
maxLength: 255
subsystem_name:
type: string
format: text
description: group subsystem name
example: Subsystem123
minLength: 0
maxLength: 255
created_at:
type: string
format: date-time
description: group member created at
example: '2018-12-15T00:00:00.001Z'
minLength: 24
maxLength: 24
LocalGroupDescription:
type: object
required:
- description
properties:
description:
type: string
description: description for the LocalGroup
format: text
minLength: 1
maxLength: 255
pattern: ^[a-zA-Z0-9-_,.;:!? ]*$
example:
name: This is an awesome local group!
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: X-Road-ApiKey token=<api key>
x-refined-from:
- security-server-admin-openapi.yaml
- x-road-global-security-server-admin-openapi.yml